Skip to content

Commit d336280

Browse files
committed
chore: added README.md from a community member PR
#167
1 parent 8887f72 commit d336280

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,20 +21,20 @@ They require approved PR.
2121
A webhook has been installed on the publish branch to
2222
https://publish.d20i0wkqbblkur.amplifyapp.com/
2323
https://github.com/pycom/pycom-documentation/tree/master
24-
24+
2525
### Updating documentation pages (no development firmware API changes)
2626
Use this workflow if you want to update documentation pages
2727
(you are not updating pages with new development firmware API).
2828

2929
$ git checkout publish
3030
$ git pull
3131
$ git checkout -b my-docs-update
32-
32+
3333
After you push your changes to your branch, go to GitHub and create two pull requests.
3434
So your branch is merged both to `publish` and `development-publish` branch.
3535

36-
After a moment both https://docs.pycom.io and https://development.pycom.io will be updated.
37-
36+
After your pull request has been reviewed and merged both https://docs.pycom.io and https://development.pycom.io will be updated.
37+
3838
![no fw api changes](static/github/nonFwChanges.jpg)
3939

4040
### Adding development firmware API changes
@@ -47,7 +47,7 @@ When a user clicks on development dropdown on any firmware API change, he/she wi
4747
$ git checkout development-publish
4848
$ git pull
4949
$ git checkout -b my-fw-api-update
50-
50+
5151
After you push your changes to your branch,
5252
go to GitHub and create a pull with **development-publish** branch as a base branch.
5353

@@ -62,7 +62,7 @@ In this case, you want to sync "development" version of docs with the "stable" d
6262
$ git pull
6363
$ git checkout -b my-sync-branch
6464
$ git merge development-publish
65-
65+
6666
After you push your changes to your branch,
6767
go to GitHub and create a pull with **development-publish** branch as a base branch.
6868

0 commit comments

Comments
 (0)