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

fix(docs): improve WordPress tutorial #20520

Merged
merged 15 commits into from
Jan 14, 2020

Conversation

TylerBarnes
Copy link
Contributor

Closes #20080

I went through the tutorial locally and followed all the steps and made updates as I went through, then afterwards I followed all my updated steps again from scratch to make sure it's all working properly.

I noticed the demo url dev-gatbsyjswp.pantheonsite.io didn't actually work anymore. Since that was a dev site, pantheon froze it after a period of inactivity. I've launched the demo site to live-gatbsyjswp.pantheonsite.io and updated the URL here, that one wont freeze if it's inactive. I'm not sure how long the dev- site has been down for.

I also noticed the README for gatsby-source-wordpress had a WordPress.org url listed in the plugin options example, but lower down had hostingWPCOM: false. I updated that url to live-gatbsyjswp.pantheonsite.io for consistency as that site is a WordPress.org site.

@TylerBarnes TylerBarnes requested review from gillkyle and a team January 9, 2020 23:39
@TylerBarnes TylerBarnes requested a review from a team as a code owner January 9, 2020 23:39
Copy link
Contributor

@gillkyle gillkyle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is so awesome, thanks a ton for helping out on this @TylerBarnes 😭🎉

I just pulled it to verify that the example site runs which is a great help. Looks like a lot of really worthwhile clarifications.

I looked at the WordPress sourcing recipe as well because that content is similar to this.

One thing I think could be updated is the README for the example. It currently says it's not a working example but seems to work great now 🙂

@TylerBarnes
Copy link
Contributor Author

Thanks for mentioning that README @gillkyle . I updated it and removed the "important note" at the end as it doesn't seem to apply anymore.

Copy link
Contributor

@gillkyle gillkyle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this looks great!

@tcope25 tcope25 added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Jan 10, 2020
@gillkyle gillkyle merged commit d5253f2 into gatsbyjs:master Jan 14, 2020
@TylerBarnes TylerBarnes deleted the docs/improve-wordpress-tutorial branch January 14, 2020 20:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Wordpress tutorial is broken?
4 participants