Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs should use relative links #1571

Closed
thockin opened this issue Oct 3, 2014 · 8 comments · Fixed by #10681
Closed

Docs should use relative links #1571

thockin opened this issue Oct 3, 2014 · 8 comments · Fixed by #10681
Assignees
Labels
kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/documentation Categorizes issue or PR as related to documentation. priority/backlog Higher priority than priority/awaiting-more-evidence. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery.
Milestone

Comments

@thockin
Copy link
Member

thockin commented Oct 3, 2014

rather than https://github...kubernetes/...

@bgrant0607 bgrant0607 added kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/documentation Categorizes issue or PR as related to documentation. priority/backlog Higher priority than priority/awaiting-more-evidence. labels Oct 3, 2014
@bgrant0607
Copy link
Member

For links to other docs and to code. That way, the cross references will work within forks of the main repo.

Links to issues and the wiki need to be fully qualified still.

matttproud added a commit to matttproud/kubernetes that referenced this issue Oct 8, 2014
This commit addresses issue kubernetes#1571, which requests that all internal
Kubernetes links are swapped to relative ones to better facilitate
browsing of documentation on local forks, not to mention make the
documentation have less needless boilerplate.
@matttproud
Copy link
Contributor

@thockin, #1656 for you to review for this issue.

@davidopp davidopp added the sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. label Feb 17, 2015
@bgrant0607 bgrant0607 added priority/awaiting-more-evidence Lowest priority. Possibly useful, but not yet enough support to actually get it done. and removed priority/backlog Higher priority than priority/awaiting-more-evidence. labels Feb 28, 2015
krousey referenced this issue in jeffmendoza/kubernetes May 28, 2015
@bgrant0607
Copy link
Member

cc @thockin

@bgrant0607 bgrant0607 added this to the v1.0 milestone Jul 1, 2015
@bgrant0607 bgrant0607 added priority/backlog Higher priority than priority/awaiting-more-evidence. and removed priority/awaiting-more-evidence Lowest priority. Possibly useful, but not yet enough support to actually get it done. labels Jul 1, 2015
@bgrant0607
Copy link
Member

Now more important since we're forking the docs for each release.
cc @nikhiljindal

@thockin
Copy link
Member Author

thockin commented Jul 2, 2015

I'm changing it all to minimal ../../foo and ./bar links, but as I finsih
it, I wonder if it would be easier to maintain if everything did ".." to
the root. So ./foo might become ../../../docs/bar/foo - it's longer but
easier to grep for... Thoughts?

On Wed, Jul 1, 2015 at 12:36 PM, Brian Grant notifications@github.com
wrote:

Now more important since we're forking the docs for each release.
cc @nikhiljindal https://github.com/nikhiljindal


Reply to this email directly or view it on GitHub
#1571 (comment)
.

@bgrant0607
Copy link
Member

Backtracking to root: I can see the value, but think we have bigger fish to fry.

@bgrant0607
Copy link
Member

cc @lavalamp re. link checker

@lavalamp
Copy link
Member

It's easy to make the link script do whatever we want. I have it NOT
backtracking to root right now (or will when today's thockalamp changes
merge), since it was inconsistent before and that was most straightforward.
But I can put it the other way, too.
On Jul 10, 2015 9:22 PM, "Brian Grant" notifications@github.com wrote:

cc @lavalamp https://github.com/lavalamp re. link checker


Reply to this email directly or view it on GitHub
#1571 (comment)
.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/documentation Categorizes issue or PR as related to documentation. priority/backlog Higher priority than priority/awaiting-more-evidence. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants