-
Notifications
You must be signed in to change notification settings - Fork 10.3k
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
replace absolute links with relative links for gatsbyjs.org docs #2999
Conversation
These links have to function both within gatsbyjs.org and within github.com, so I think they should be written as inline HTML. The currently do not resolve correctly within gatsbyjs.org. gatsbyjs#2998
Deploy preview ready! Built with commit 0e7d3f2 |
I just realized that it may not be the goal to have gatsbyjs.org links resolve correctly in the docs on GitHub. After all, none of the other gatsbyjs.org relative path links would work in the docs here. I'd be happy to submit another PR with the links written in Markdown, just using relative paths instead of absolute paths. |
Looks like the bug is definitely that they should be relative urls like the rest of the docs (as you note in your issue, and in the recent comment). I'd swap them to relative in the PR, but you can always ping Kyle and see what his thoughts are. The build setup is really the cause of this, as it's not just docs, but also non-doc pages that get pulled into the live site. Small downside, but maybe there should be a note somewhere that the docs source of truth is the site rather than the repo. sidebar: I knew your name looked familiar! Great to see an FS grad making PRs on Gatsby! 👍 |
@markmichon You, sir, have great taste in static site generators. :-) Glad to see you here! I'll edit the PR for relative links, since that's consistent with the rest of the docs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Resolving issue #2998 with relative links.
Deploy preview failed. Built with commit 7eb3799 https://app.netlify.com/sites/using-glamor/deploys/5a19bd8ba11477454ee5b714 |
Thanks for this fix! And yeah, we should add a note somehow in the docs on Github to encourage people to not read them there. Every once in awhile people post PRs/issues saying the links are wrong. |
Hiya @benforshey! 👋 This is definitely late, but on behalf of the entire Gatsby community, I wanted to say thank you for being here. Gatsby is built by awesome people like you. Let us say “thanks” in two ways:
If you have questions, please don’t hesitate to reach out to us: tweet at @gatsbyjs and we’ll come a-runnin’. Thanks again! 💪💜 |
These links have to function both within gatsbyjs.org and within github.com, so I think they should be written as inline HTML. The currently do not resolve correctly within gatsbyjs.org. #2998