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(setting-up-your-local-dev-environment): beautify some parts #19349

Merged
merged 10 commits into from
Nov 26, 2019

Conversation

muescha
Copy link
Contributor

@muescha muescha commented Nov 7, 2019

Description

  • restructure some parts to not miss there a 2 different gatsby-cli and gatsby-dev-cli
  • some headings
    - add a hint about Pull Bot removed by request

Related Issues

n/a

Wordings

i am not good in wording docs, suggestions are welcome

@muescha muescha requested a review from a team as a code owner November 7, 2019 21:01
@muescha
Copy link
Contributor Author

muescha commented Nov 7, 2019

i feel the yarn run watch should be under the feature changes heading and not in docs changes heading?

@muescha
Copy link
Contributor Author

muescha commented Nov 8, 2019

should we also add some notes about develop-runner - i only found this description here #19092 (review)

This is so cool! 👍

I think you are missing child/parent relationship cases, so when child/parent relationship is added either through action or by setting 'parent' field.

We usually test against .org (www folder in monorepo) using gatsby-dev-cli. You can test against multiple sites using develop-runner. You need to modify source code a bit, but it's still very handy.

We often publish a pre-release version for packages with big changes, then you can use it to test with develop-runner. Eg you can reuse tag @schema-customization. (To do it, go to gatsby/packages/gatsby and do yarn publish --tag schema-customization).

@pieh
Copy link
Contributor

pieh commented Nov 8, 2019

should we also add some notes about develop-runner - i only found this description here #19092 (review)

I'm not sure - we ourselves use this pretty rarely, only when there is rewrite of one of major core function that potentially could introduce bugs (or unforeseen breaking changes). Last time we used it (before schema rebuilding PR) was materialization for data layer.

The script itself also takes a loong time to run, so I don't want to force it on contributors, as it's not needed for most of PRs.

It makes sense to me to make a note about it somewhere, but this could be separate PR to not scope creep this one?

@pieh
Copy link
Contributor

pieh commented Nov 8, 2019

i feel the yarn run watch should be under the feature changes heading and not in docs changes heading?

Yes, if none of the packages is changed - we don't need yarn watch - so purely documentation work, potentially only need to install deps for www and run gatsby develop there (but it also isn't strictly needed)

@muescha
Copy link
Contributor Author

muescha commented Nov 8, 2019

So I can leaveThe watch part it as is?

@muescha
Copy link
Contributor Author

muescha commented Nov 8, 2019

placed suggestion about developer-runner into #19380

@laurieontech
Copy link
Contributor

This is looking really good. Love the additional details for such a popular write up.

@jbampton jbampton added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Nov 19, 2019
@muescha
Copy link
Contributor Author

muescha commented Nov 23, 2019

updated from suggestions of @laurieontech and @jbampton

@jbampton jbampton requested review from jbampton and removed request for jbampton November 23, 2019 03:13
@jbampton jbampton self-requested a review November 23, 2019 03:14
Copy link
Contributor

@jbampton jbampton left a comment

Choose a reason for hiding this comment

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

Looks better thanks 👍

@jbampton jbampton requested review from jbampton and removed request for jbampton November 23, 2019 03:16
@muescha
Copy link
Contributor Author

muescha commented Nov 23, 2019

:( CI test are failing - but there are out of my scope

@jbampton
Copy link
Contributor

Also maybe you should update the PR description to remove add a hint about Pull Bot

@muescha
Copy link
Contributor Author

muescha commented Nov 23, 2019

done

@laurieontech laurieontech merged commit c120b1e into master Nov 26, 2019
@delete-merged-branch delete-merged-branch bot deleted the docs/local-dev-environment branch November 26, 2019 14:44
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