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

chore(docs): Add clarification for Pro Tip on Part 4 of tutorial #36918

Merged
merged 2 commits into from
Nov 3, 2022

Conversation

BreGoNunez
Copy link
Contributor

Description

It may have been just me, but when I was following this part of the tutorial. I copied and pasted the code and replaced what I already had in the Head of my blog page, since I was following it sequentially. I faced various errors since the GraphQL query didn't have the data for the metadata; only to realize this was already handled by the Seo components some steps ago. So I wanted to make a note to make it clear that this wasn't necessary since we had the Seo component already.

Also, the video tutorial (pretty good!) doesn't mention or show this tip so it took me longer to realize my mistake.

Documentation

https://www.gatsbyjs.com/docs/tutorial/part-4/

Related Issues

No related issues.

It may have been just me, but when I was following this part of the tutorial (https://www.gatsbyjs.com/docs/tutorial/part-4/#:~:text=export%20default%20BlogPage-,Pro%20Tip%3A,-The%20Gatsby%20Head). I copied and pasted the code and replaced what I already had in the Head of my blog page, since I was following it sequentially. I faced various errors since the GraphQL query didn't have the data for the metadata; only to realize this was already handled by the Seo components some steps ago. So I wanted to make a note to make it clear that this wasn't necessary since we had the Seo component already.

Also, the video tutorial doesn't mention or show this tip so it took me longer to realize my mistake.
@gatsbot gatsbot bot added the status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer label Oct 30, 2022
@LekoArts LekoArts added type: documentation An issue or pull request for improving or updating Gatsby's documentation and removed status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer labels Nov 1, 2022
@LekoArts
Copy link
Contributor

LekoArts commented Nov 1, 2022

Hi, thanks for the PR! Currently I'm more inclined to close the PR as we have announcements with "Pro Tip" throughout the tutorial. They are always separate callouts independent from the flow so I'm interested to know why for this specific "Pro Tip" you thought it would be about the tutorial?

@BreGoNunez
Copy link
Contributor Author

Hi @LekoArts! No problem! This is my first PR so thanks for giving some feedback on the fit for it.
It's just that the other "Pro Tips", although independent of the flow, can be replicated within the project just for testing purposes, but this one, when testing it, it threw the error I mentioned, since we were updating our src/pages/blog.js page, and it was at the bottom I thought the last step would be modifying the export Head on (Use a page query to pull the list of post filenames into your blog page) and this Tip was about doing so.

However I understand your take, the Tips do actually "live on their own"; it could have been just a "zoned out" moment for me.

Copy link
Contributor

@LekoArts LekoArts left a comment

Choose a reason for hiding this comment

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

Thanks for the input! I adjusted your changes to point out part 6 of the tutorial, hope that makes it clearer

@LekoArts LekoArts merged commit c86aa7e into gatsbyjs:master Nov 3, 2022
@BreGoNunez
Copy link
Contributor Author

Thank you for the time and feedback! The summary of the note made it much clearer!
Thanks peeps for the Framework. Keep the amazing work.

@BreGoNunez BreGoNunez deleted the patch-2 branch November 4, 2022 05:31
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.

2 participants