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(tutorial): finishing touches #32833

Merged
merged 8 commits into from
Aug 20, 2021
Merged

Conversation

meganesu
Copy link
Contributor

@meganesu meganesu commented Aug 17, 2021

Description

Adds finishing touches to the new Gatsby Tutorial, as well as assorted copy edits / typo fixes.

Finishing touches include:

  • Add checks for understanding and key takeaways to Part 1.
  • Create an example repo that follows along with the Tutorial content.
    • Add callouts to each part at the beginning (where we left off) and the end (what we did in this part)
  • Update the link to the example site in Part 1 to point to the example repo deployed on Gatsby Cloud.
  • Add image showing folder structure with blog subdirectories and hero images (Part 7).

ch32545

Documentation

/docs/tutorial/*

@gatsbot gatsbot bot added the status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer label Aug 17, 2021
@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 Aug 17, 2021
@meganesu meganesu marked this pull request as ready for review August 19, 2021 19:19
Copy link
Contributor

@thinkybeast thinkybeast left a comment

Choose a reason for hiding this comment

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

👍 !

Copy link
Contributor

@jxnblk jxnblk left a comment

Choose a reason for hiding this comment

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

:shipit:


**Want to see how it all fits together?** Check out the commit history in the [GitHub repo for the finished example site](https://github.com/gatsbyjs/tutorial-example).

</Announcement>
Copy link
Contributor

Choose a reason for hiding this comment

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

Definitely not blocking, but you can put something like this into its own MDX file to turn it into a component, then import it places like this and in the other parts, e.g. import CommitHistoryCallout from './commit-history-callout.mdx

Another thought I had when looking at this: if you have 1-to-1 commits with each step, you could link directly to that commit in GitHub

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh nice, I'd never thought about importing from other MDX files.

Also I thought about adding links to the exact commits, but I've been rebasing and force-pushing the demo site when I make tweaks to the Tutorial content, which messes up all the commit hashes. I figured it would be less work to maintain to use a generic link to the repo. (Unless maybe there's some git trick for updating branches when you rebase?)

@LekoArts LekoArts merged commit 1706d8f into master Aug 20, 2021
@LekoArts LekoArts deleted the docs/tutorial-final-touches branch August 20, 2021 11:58
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.

4 participants