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: Update getting started with code #30447

Merged
merged 4 commits into from
Apr 13, 2021

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Apr 1, 2021

Description

  • Updates the Getting started with code documentation to make it more accessible to the first-time contributors.
  • Replaces 'Development Tools (Node)' section with a 'Prerequisites' section including Node.js, Git and [Optional] Docker.
  • Adds a detail about WSL2 that is needed to install Docker on a Windows 10 computer.
  • Replaces npm build with npm run dev as a primary command for building Gutenberg: the contributors will probably want to see the changes and debug information when starting out.
  • Clarifies that wp-env script sets up the Docker Container and runs it.

How has this been tested?

Run through tutorial and confirm it works as expected

Types of changes

Docs

@obulat obulat added the [Type] Developer Documentation Documentation for developers label Apr 1, 2021
@github-actions github-actions bot added the First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository label Apr 1, 2021
@github-actions
Copy link

github-actions bot commented Apr 1, 2021

👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @obulat! In case you missed it, we'd love to have you join us in our Slack community, where we hold regularly weekly meetings open to anyone to coordinate with each other.

If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information.


## Local Environment
## Local WordPress Environment

If you are familiar with WordPress and already have an environment setup, use the above build as a standard WordPress plugin by putting the gutenberg directory in your wp-content/plugins/ directory.
Copy link
Contributor Author

@obulat obulat Apr 2, 2021

Choose a reason for hiding this comment

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

To me it is not very clear what 'Local WordPress Environment setup' is. I have installed WordPress downloaded from wordpress.org before. But 'Local WordPress Environment' sounds like it's something quite different, and I'm not sure what the differences are. So, maybe adding the sentence from below in this section : 'To test (or try out) a WordPress plugin (or Gutenberg WordPress plugin), you need to have WordPress installed' would make it clearer?

@jasmussen jasmussen requested a review from a team April 12, 2021 13:16
@jasmussen
Copy link
Contributor

I would very much appreciate eyes and green checks on this one!

Copy link
Member

@mkaz mkaz left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution @obulat 👍
They all look good and add clarity in several areas.

@gziolo gziolo merged commit 2d2bc88 into WordPress:trunk Apr 13, 2021
@github-actions github-actions bot added this to the Gutenberg 10.5 milestone Apr 13, 2021
@obulat obulat deleted the update/getting-started-with-code-docs branch April 13, 2021 06:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants