Improve setting-up.md documentation #8920 #8939
Conversation
Revised a few sentences to make them clearer and shorter
docs/setting-up.md
Outdated
| @@ -1,14 +1,14 @@ | |||
| # Setting up a development environment | |||
|
|
|||
| This is a step-by-step guide to setting up a development environment in your local machine. | |||
| You will use that environment to work on features, enhancements, bug fixes, etc. which ultimately allows you to contribute to the project. | |||
| This is a step-by-step guide for setting up a development environment in your local machine. | |||
There was a problem hiding this comment.
yes, "on your local machine" makes more sense.
docs/setting-up.md
Outdated
|
|
||
| 1. Add a remote name (e.g `upstream`) for the main repo for your repo to keep in sync with, and then fetch the remote-tracking branches from the main repo. | ||
| 1. Add a remote name (e.g upstream) for your copy of the main repo. Fetch the remote-tracking branches from the main repo to keep it in sync with your copy. |
There was a problem hiding this comment.
Let's keep the ` around upstream as its a special word in this context
There was a problem hiding this comment.
I missed the single quotes. Will change it.
docs/setting-up.md
Outdated
| @@ -46,7 +46,7 @@ More information can be found at [this documentation](https://help.github.com/ar | |||
| 1. Install Google Cloud SDK. Follow the directions given [here](https://cloud.google.com/sdk/downloads). | |||
| Note that you *do not* need to [initialize the SDK](https://cloud.google.com/sdk/docs/initializing). | |||
| ```sh | |||
| # This command is to be run at the Google Cloud SDK directory | |||
| # Execute this command at the Google Cloud SDK directory | |||
There was a problem hiding this comment.
Lets keep this consistent with line 61.
Change to Run the following command
tshradheya
added
s.FinalReview
tshradheya
added
s.ToMerge
tshradheya
changed the title
|
Thanks for the contribution @cybersol795 . Looking forward to the future PR's which aim to improve the documentation. Also in future please create a new branch and then create a PR from that :) |
|
@tshradheya I don't seem to have the permissions to check out a new branch on Teammates. My changes are on a non-master branch on my fork but the PR that I create can only be merged into one of the existing branches. Any ideas? |
|
When creating a PR, create it from the |
xpdavid
added
the
c.DevOps
Fixes #8920
Typos and grammatical errors are removed and some sentence structures have slightly changed in some sections. Please review the revisions and if there is any change that you don't approve please leave me a comment. Thank you!
p.s., if you approve, after this issue is closed, I will create ~3 more issues for a few other documentation files in the repository (but will create and close them one by one)