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

Updates to Documentation #18446

Merged
merged 3 commits into from Nov 24, 2019
Merged

Updates to Documentation #18446

merged 3 commits into from Nov 24, 2019

Conversation

@davidshq
Copy link
Contributor

davidshq commented Nov 11, 2019

I've made changes to contributors/getting-started.md and /developers/tutorials/javascript/js-build-setup.md.

getting-started.md

  • Added subheadings under Local Environment to clarify instructions: "Using Docker", "Using an Existing Local WordPress Install", "Access the Local WordPress Install" and "Toggling Debug Systems".

js-build-setup.md

  • Minor spelling/grammar improvements.
  • Broke out inline list of advantages of ESNext into a separate list
  • Changed a reference to "those libraries" to "webpack or babel" to clarify.
  • Added a link to the @wordpress/scripts documentation (previously referenced but no link).
  • Attempted to clarify that the "Quick Start" is not what follows but following directions in examples.
  • Ubuntu will not install node using apt install node, updated to apt install nodejs & apt install npm
  • Changed "Webpack & Babel" heading to "Setting Up wp-scripts build" to clarify the subject covered.
  • Changed reference to "in this tutorial" to actual tutorial name: "Loading JavaScript" to clarify.
davidshq added 2 commits Nov 11, 2019
Added additional headings to Local Environment to help clarify which steps should be used for which desired outcome.
Made a number of small changes throughout to clarify certain points.
Copy link
Member

mkaz left a comment

Thanks for the contribution, good clean up changes. The additional structure makes it easier to read.
One minor change but looks good.

There is overlap with this PR changing one of the same docs page:
#18423

…uild-setup.md


Sure.

Co-Authored-By: Marcus Kazmierczak <marcus@mkaz.com>
@mkaz
mkaz approved these changes Nov 24, 2019
Copy link
Member

mkaz left a comment

Thanks 👍

@mkaz mkaz merged commit aee75f6 into WordPress:master Nov 24, 2019
2 checks passed
2 checks passed
pull-request-automation
Details
Travis CI - Pull Request Build Passed
Details
@youknowriad youknowriad added this to the Gutenberg 7.0 milestone Nov 25, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.