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

Updated getting-started.md #18769

Merged
merged 2 commits into from Nov 29, 2019
Merged

Updated getting-started.md #18769

merged 2 commits into from Nov 29, 2019

Conversation

@davidshq
Copy link
Contributor

davidshq commented Nov 26, 2019

Description

Improvements to the getting-started.md documentation. Specifically:

  1. Now explicitly note that when node is installed one must run the scripts from within the local gutenberg repo directory.
  2. Broke into additional sections Local Environment.
    • Added Step 1: Installing a Local Environment
    • Changed "Using Docker" to "Quickest Method: Using Docker"
    • Prepended "Alternative Method:" to "Using an Existing Local WordPress Install"
    • Added Step 2: Accessing and Configuring the Local WordPress Install
  3. Fleshed out the commands needed to add environment variables (especially on Windows, export will not work).
  4. Changed verbiage regarding shutting down/starting up docker instance.
  5. Clarified that the Toggling Debug Systems command will only work on Linux/MacOS (I do not have the correct command for Windows yet).
Copy link
Contributor

ZebulanStanphill left a comment

I see a few minor typos, but otherwise this looks like a good improvement to me.

docs/contributors/getting-started.md Outdated Show resolved Hide resolved
docs/contributors/getting-started.md Outdated Show resolved Hide resolved
docs/contributors/getting-started.md Show resolved Hide resolved
@Soean
Soean approved these changes Nov 29, 2019
@Soean Soean merged commit 659e46b into WordPress:master Nov 29, 2019
2 checks passed
2 checks passed
pull-request-automation
Details
Travis CI - Pull Request Build Passed
Details
@Soean

This comment has been minimized.

Copy link
Member

Soean commented Nov 29, 2019

Looks good, thanks for improving the docs.

@youknowriad youknowriad added this to the Gutenberg 7.1 milestone Dec 9, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.