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): reformat tutorial - part zero #21988

Merged
merged 5 commits into from
Mar 9, 2020

Conversation

muescha
Copy link
Contributor

@muescha muescha commented Mar 5, 2020

Description

i reformat the tutorial to be more clear:

  • each command a user has to execute or to type becomes a shell code block
  • note sections formatted the same
  • hints sections formatted the same
  • added a TOC for distros
  • combined the 2 similar sections into one at create a gatsby site

This is more beginners friendly to know which part he has to type and which code snippet is only for explanation.

Some code snippets was placed in this way that you can miss some parts because of line breaks like this and you miss the first command and get unkown errors (it is easy to miss the sudo in this example:

Bildschirmfoto 2020-03-02 um 00 42 54

vs

Bildschirmfoto 2020-03-05 um 12 33 03

Question

i think the commands are repeating in section "create a gatsby site" - maybe combine it and add a hin section after each command which explains the command (instead of repeating it later again after the screenshot)

answer was: Yes

@muescha muescha requested a review from a team as a code owner March 5, 2020 13:54
@muescha muescha changed the title chore(docs): reformat tutorial chore(docs): reformat tutorial - part zero Mar 5, 2020
Ekwuno
Ekwuno previously approved these changes Mar 5, 2020
Copy link
Contributor

@Ekwuno Ekwuno left a comment

Choose a reason for hiding this comment

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

This looks great @muescha! Thanks for taking the time to do this. 💜

@Ekwuno
Copy link
Contributor

Ekwuno commented Mar 5, 2020

I agree! a hint section to explain what the command does would be great! Can you send in a PR for that? @muescha

@muescha
Copy link
Contributor Author

muescha commented Mar 5, 2020

ok - i will condense this section and combine it

an new PR after this or as an update to this PR?

@Ekwuno
Copy link
Contributor

Ekwuno commented Mar 5, 2020

ok - i will condense this section and combine it

an new PR after this or as an update to this PR?

Maybe just update this PR. Thanks again!

@Ekwuno Ekwuno self-assigned this Mar 5, 2020
@muescha muescha force-pushed the muescha/fix/docs-tutorial-zero branch from c912aff to e883e6a Compare March 6, 2020 18:29
@muescha
Copy link
Contributor Author

muescha commented Mar 6, 2020

@Ekwuno combined it

@Ekwuno
Copy link
Contributor

Ekwuno commented Mar 6, 2020

@Ekwuno combined it

Thank you ! I will get this merged after I test the changes on Monday .

@Ekwuno Ekwuno merged commit 315ee1c into gatsbyjs:master Mar 9, 2020
@muescha muescha deleted the muescha/fix/docs-tutorial-zero branch March 9, 2020 15:16
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.

2 participants