Skip to content

chore: added README.md from a community member PR #173

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Oct 28, 2019
Merged

chore: added README.md from a community member PR #173

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,20 +21,20 @@ They require approved PR.
A webhook has been installed on the publish branch to
https://publish.d20i0wkqbblkur.amplifyapp.com/
https://github.com/pycom/pycom-documentation/tree/master

### Updating documentation pages (no development firmware API changes)
Use this workflow if you want to update documentation pages
(you are not updating pages with new development firmware API).

$ git checkout publish
$ git pull
$ git checkout -b my-docs-update

After you push your changes to your branch, go to GitHub and create two pull requests.
So your branch is merged both to `publish` and `development-publish` branch.

After a moment both https://docs.pycom.io and https://development.pycom.io will be updated.
After your pull request has been reviewed and merged both https://docs.pycom.io and https://development.pycom.io will be updated.

![no fw api changes](static/github/nonFwChanges.jpg)

### Adding development firmware API changes
Expand All @@ -47,7 +47,7 @@ When a user clicks on development dropdown on any firmware API change, he/she wi
$ git checkout development-publish
$ git pull
$ git checkout -b my-fw-api-update

After you push your changes to your branch,
go to GitHub and create a pull with **development-publish** branch as a base branch.

Expand All @@ -62,7 +62,7 @@ In this case, you want to sync "development" version of docs with the "stable" d
$ git pull
$ git checkout -b my-sync-branch
$ git merge development-publish

After you push your changes to your branch,
go to GitHub and create a pull with **development-publish** branch as a base branch.

Expand Down