Hyperlink in the middle of an article

[BendixSpring]

Can we put hyperlinks in the middle of an article?

It makes the tool much more useful.

[DinisCruz]

Yes, we need to support it, can you open this on TeamMentor/Master since that is a code issue

Dinis Cruz

On 16 Apr 2013, at 17:01, Danny Harris notifications@github.com wrote:

Can we put hyperlinks in the middle of an article?

It makes the tool much more useful.

— Reply to this email directly or view it on GitHub.

[tlaloc75]

Is it a code issue or do we just need to add a link to the content in this article?

On Apr 16, 2013, at 10:59 AM, Dinis Cruz notifications@github.com wrote:

Yes, we need to support it, can you open this on TeamMentor/Master since that is a code issue

Dinis Cruz

On 16 Apr 2013, at 17:01, Danny Harris notifications@github.com wrote:

Can we put hyperlinks in the middle of an article?

It makes the tool much more useful.

— Reply to this email directly or view it on GitHub. — Reply to this email directly or view it on GitHub.

[BendixSpring]

I do know that the article should be fixed by adding the hyperlink mid-article. I don’t know if this is a systemic issue. Can we put hyperlinks anywhere in an article?

--Danny

From: tlaloc75 [mailto:notifications@github.com] Sent: Tuesday, April 16, 2013 1:08 PM To: TMContent/Lib_Docs Cc: Danny Harris Subject: Re: [Lib_Docs] Hyperlink in the middle of an article (#11)

Is it a code issue or do we just need to add a link to the content in this article?

On Apr 16, 2013, at 10:59 AM, Dinis Cruz notifications@github.com wrote:

Yes, we need to support it, can you open this on TeamMentor/Master since that is a code issue

Dinis Cruz

On 16 Apr 2013, at 17:01, Danny Harris notifications@github.com wrote:

Can we put hyperlinks in the middle of an article?

It makes the tool much more useful.

— Reply to this email directly or view it on GitHub. — Reply to this email directly or view it on GitHub.

— Reply to this email directly or view it on GitHub https://github.com/TMContent/Lib_Docs/issues/11#issuecomment-16457724 .

[tlaloc75]

We should be able to add links anywhere, there is not a restriction that I know of. We try to collect them at the end for additional resources, etc. but that doesn't block us from inline links where they make sense.

On Apr 16, 2013, at 11:17 AM, Danny Harris notifications@github.com wrote:

I do know that the article should be fixed by adding the hyperlink mid-article. I don’t know if this is a systemic issue. Can we put hyperlinks anywhere in an article?

--Danny

From: tlaloc75 [mailto:notifications@github.com] Sent: Tuesday, April 16, 2013 1:08 PM To: TMContent/Lib_Docs Cc: Danny Harris Subject: Re: [Lib_Docs] Hyperlink in the middle of an article (#11)

Is it a code issue or do we just need to add a link to the content in this article?

On Apr 16, 2013, at 10:59 AM, Dinis Cruz notifications@github.com wrote:

Yes, we need to support it, can you open this on TeamMentor/Master since that is a code issue

Dinis Cruz

On 16 Apr 2013, at 17:01, Danny Harris notifications@github.com wrote:

Can we put hyperlinks in the middle of an article?

It makes the tool much more useful.

— Reply to this email directly or view it on GitHub. — Reply to this email directly or view it on GitHub.

— Reply to this email directly or view it on GitHub https://github.com/TMContent/Lib_Docs/issues/11#issuecomment-16457724 . — Reply to this email directly or view it on GitHub.

[DinisCruz]

I thought we were talking about adding hyperlinks into specific parts on an article.

At the moment the articles are HTML or WikiText, and both support the use of links in its contents

Dinis Cruz

On 16 Apr 2013, at 18:08, tlaloc75 notifications@github.com wrote:

Is it a code issue or do we just need to add a link to the content in this article?

On Apr 16, 2013, at 10:59 AM, Dinis Cruz notifications@github.com wrote:

Yes, we need to support it, can you open this on TeamMentor/Master since that is a code issue

Dinis Cruz

On 16 Apr 2013, at 17:01, Danny Harris notifications@github.com wrote:

Can we put hyperlinks in the middle of an article?

It makes the tool much more useful.

— Reply to this email directly or view it on GitHub. — Reply to this email directly or view it on GitHub.

— Reply to this email directly or view it on GitHubhttps://github.com/TMContent/Lib_Docs/issues/11#issuecomment-16457724 .

[romichg]

In talking with Serge, in the past, we tried to avoid putting links in line of the article because it makes it hard to manage them when they get outdated. Serge feel free to chime in. On Apr 17, 2013 3:58 AM, "Dinis Cruz" notifications@github.com wrote:

I thought we were talking about adding hyperlinks into specific parts on an article.

At the moment the articles are HTML or WikiText, and both support the use of links in its contents

Dinis Cruz

On 16 Apr 2013, at 18:08, tlaloc75 notifications@github.com wrote:

Is it a code issue or do we just need to add a link to the content in this article?

On Apr 16, 2013, at 10:59 AM, Dinis Cruz notifications@github.com wrote:

Yes, we need to support it, can you open this on TeamMentor/Master since that is a code issue

Dinis Cruz

On 16 Apr 2013, at 17:01, Danny Harris notifications@github.com wrote:

Can we put hyperlinks in the middle of an article?

It makes the tool much more useful.

— Reply to this email directly or view it on GitHub. — Reply to this email directly or view it on GitHub.

— Reply to this email directly or view it on GitHub< https://github.com/TMContent/Lib_Docs/issues/11#issuecomment-16457724> .

— Reply to this email directly or view it on GitHubhttps://github.com/TMContent/Lib_Docs/issues/11#issuecomment-16475855 .

[BendixSpring]

This is certainly a valid concern. I do believe that Dinis has a tool to help check links, and I think we ought to do a link verification of some sort before we do a release. This is simply good content hygiene.

I understand the maintenance issues, but ultimately we are trying to make a tool that developers can easily use to help them write better code. Failing to have links in the body of an article for important keywords, pointing to other internal articles, or pointing externally is going to make using TM more frustrating to the users.

--Danny

From: Roman Garber [mailto:notifications@github.com] Sent: Wednesday, April 17, 2013 1:56 AM To: TMContent/Lib_Docs Cc: Danny Harris Subject: Re: [Lib_Docs] Hyperlink in the middle of an article (#11)

In talking with Serge, in the past, we tried to avoid putting links in line of the article because it makes it hard to manage them when they get outdated. Serge feel free to chime in. On Apr 17, 2013 3:58 AM, "Dinis Cruz" <notifications@github.com mailto:notifications@github.com > wrote:

I thought we were talking about adding hyperlinks into specific parts on an article.

At the moment the articles are HTML or WikiText, and both support the use of links in its contents

Dinis Cruz

On 16 Apr 2013, at 18:08, tlaloc75 <notifications@github.com mailto:notifications@github.com > wrote:

Is it a code issue or do we just need to add a link to the content in this article?

On Apr 16, 2013, at 10:59 AM, Dinis Cruz <notifications@github.com mailto:notifications@github.com > wrote:

Yes, we need to support it, can you open this on TeamMentor/Master since that is a code issue

Dinis Cruz

On 16 Apr 2013, at 17:01, Danny Harris notifications@github.com wrote:

Can we put hyperlinks in the middle of an article?

It makes the tool much more useful.

— Reply to this email directly or view it on GitHub. — Reply to this email directly or view it on GitHub.

— Reply to this email directly or view it on GitHub< https://github.com/TMContent/Lib_Docs/issues/11#issuecomment-16457724> .

— Reply to this email directly or view it on GitHubhttps://github.com/TMContent/Lib_Docs/issues/11#issuecomment-16475855 .

— Reply to this email directly or view it on GitHub https://github.com/TMContent/Lib_Docs/issues/11#issuecomment-16488170 . https://github.com/notifications/beacon/5F2_eRmNmMOSmJQY77zQBwKxx3RA51x6oVTLrFPAqQZ6d-ENQu0NtGje7PNvpn1H.gif

[romichg]

I agree with you 100%. Links inline is the whole point of rich content. The conversation I had with Serge was prior to the tool being available, so perhaps we can now do differently then before. However, this needs to work for Serge.

On Wed, Apr 17, 2013 at 6:56 PM, Danny Harris notifications@github.comwrote:

This is certainly a valid concern. I do believe that Dinis has a tool to help check links, and I think we ought to do a link verification of some sort before we do a release. This is simply good content hygiene.

I understand the maintenance issues, but ultimately we are trying to make a tool that developers can easily use to help them write better code. Failing to have links in the body of an article for important keywords, pointing to other internal articles, or pointing externally is going to make using TM more frustrating to the users.

--Danny

From: Roman Garber [mailto:notifications@github.com] Sent: Wednesday, April 17, 2013 1:56 AM To: TMContent/Lib_Docs Cc: Danny Harris Subject: Re: [Lib_Docs] Hyperlink in the middle of an article (#11)

In talking with Serge, in the past, we tried to avoid putting links in line of the article because it makes it hard to manage them when they get outdated. Serge feel free to chime in. On Apr 17, 2013 3:58 AM, "Dinis Cruz" <notifications@github.com <mailto: notifications@github.com> > wrote:

I thought we were talking about adding hyperlinks into specific parts on an article.

At the moment the articles are HTML or WikiText, and both support the use of links in its contents

Dinis Cruz

On 16 Apr 2013, at 18:08, tlaloc75 <notifications@github.com <mailto: notifications@github.com> > wrote:

Is it a code issue or do we just need to add a link to the content in this article?

On Apr 16, 2013, at 10:59 AM, Dinis Cruz <notifications@github.com<mailto: notifications@github.com> > wrote:

Yes, we need to support it, can you open this on TeamMentor/Master since that is a code issue

Dinis Cruz

On 16 Apr 2013, at 17:01, Danny Harris notifications@github.com wrote:

Can we put hyperlinks in the middle of an article?

It makes the tool much more useful.

— Reply to this email directly or view it on GitHub. — Reply to this email directly or view it on GitHub.

— Reply to this email directly or view it on GitHub< https://github.com/TMContent/Lib_Docs/issues/11#issuecomment-16457724> .

— Reply to this email directly or view it on GitHub< https://github.com/TMContent/Lib_Docs/issues/11#issuecomment-16475855> .

— Reply to this email directly or view it on GitHub < https://github.com/TMContent/Lib_Docs/issues/11#issuecomment-16488170> . < https://github.com/notifications/beacon/5F2_eRmNmMOSmJQY77zQBwKxx3RA51x6oVTLrFPAqQZ6d-ENQu0NtGje7PNvpn1H.gif>

— Reply to this email directly or view it on GitHubhttps://github.com/TMContent/Lib_Docs/issues/11#issuecomment-16505188 .

[SergeTruth]

Please, don't put hyperlinks in the body of the article. It's not an original idea and we have tried it before. The results have been tragic and what's being suggested here is the same thing, so is likely to produce the same results.

The idea is like this: when we mention something that is explained in greater detail elsewhere, let's link to it. There is some variation on what exactly the criteria is for when a link should be inserted, and generally nobody has come up with a solid standard for this. Usually, people just find some article(s) where they feel it would improve the article to put some links in the body, and then the idea comes - let's do this for all the articles.

The result is like this: lots of broken/outdated links scattered throughout all the articles in sporadic places, no tool to find or enumerate the broken links, and changes to the content that don't make sense if the link is removed. I've removed hundreds of these links before by hand and there are still an unknown amount of them floating around. The article guids are supposed to be a rock-solid standard for linking to articles, but they really aren't, so it's not even safe to link to other articles like this.

The reality is: we can't even manage links effectively when they are in a little section at the end at the moment. Once we excel at managing them there, we can plan for inserting links in other places. After we make that plan, an optimistic estimate is within a quarter or two we will have the tools to do this. After we have the tools to do this, we may be able to update a library or two per quarter. However, before we make that plan, we have to figure out how to manage the links that we already have and then do it, any takers?