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

replace absolute links with relative links for gatsbyjs.org docs #2999

Merged
merged 4 commits into from
Nov 28, 2017

Conversation

benforshey
Copy link
Contributor

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

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
@gatsbybot
Copy link
Collaborator

Deploy preview ready!

Built with commit 0e7d3f2

https://deploy-preview-2999--gatsbygram.netlify.com

@benforshey
Copy link
Contributor Author

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.

@markmichon
Copy link
Contributor

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! 👍

@benforshey
Copy link
Contributor Author

@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.

@benforshey benforshey changed the title fix links for both gatsbyjs.org and github.com fix links gatsbyjs.org Nov 25, 2017
@benforshey benforshey changed the title fix links gatsbyjs.org remove absolute links for gatsbyjs.org docs Nov 25, 2017
@benforshey benforshey changed the title remove absolute links for gatsbyjs.org docs replace absolute links with relative links for gatsbyjs.org docs Nov 25, 2017
Copy link
Contributor Author

@benforshey benforshey left a 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.

@KyleAMathews
Copy link
Contributor

Deploy preview failed.

Built with commit 7eb3799

https://app.netlify.com/sites/using-glamor/deploys/5a19bd8ba11477454ee5b714

@KyleAMathews
Copy link
Contributor

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.

@KyleAMathews KyleAMathews merged commit 58de609 into gatsbyjs:master Nov 28, 2017
@KyleAMathews
Copy link
Contributor

jlengstorf pushed a commit to jlengstorf/gatsby that referenced this pull request Nov 28, 2017
…sbyjs#2999)

* fix links for both gatsbyjs.org and github.com

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

* prefer relative links over absolute for docs
@benforshey benforshey deleted the patch-1 branch November 29, 2017 13:14
@jlengstorf
Copy link
Contributor

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:

  1. We’d like to send you some Gatsby swag. As a token of our appreciation, you can go to the Gatsby Swag Store and log in with your GitHub account to get a coupon code good for one free piece of swag. (We’ve got t-shirts and hats, plus some socks that are really razzing our berries right now.)
  2. If you’re not already part of it, we just invited you to join the Gatsby organization on GitHub. This will add you to our team of maintainers. You’ll receive an email shortly asking you to confirm. By joining the team, you’ll be able to label issues, review pull requests, and merge approved pull requests.

If you have questions, please don’t hesitate to reach out to us: tweet at @gatsbyjs and we’ll come a-runnin’.

Thanks again! 💪💜

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants