Merge pull request #164 from pycom/readme-update-2

Updated readme

README.md

@@ -1,40 +1,97 @@
-# run locally
+# Pycom documentation
+
+Welcome to Pycom docs.
+
+## Run locally
 
 ```
 brew install hugo
 hugo serve
 ```
 
-# Workflow
+## Github workflow
 
-## Make documentation update
-- Checkout your branch from `master` and commit and push your changes
-- Make a PR against `master` branch (implicitly set as `master` branch is our default branch) 
-- Assign a reviewer and let your PR to be merged
+The default branch is `publish`. Changes pushed into this branch, will update [docs.pycom.io](https://docs.pycom.io/).
 
-## Deploy changes
-- Make PR from `master` against `publish` branch
-- Assign a reviewer and let your PR to be merged
-- docs were updated
+Second "live" branch is `development-publish` Changes pushed into this branch, will update [development.pycom.io](https://development.pycom.io)
 
-# some infos:
-
-- assets are in ./static directory, a directory aliased at /
-- css in /themes/doc-theme/static/doc-theme.css
-- SUMMARY.md is in config.toml
-
-
-# help
-
-- gohugo.io
-
-
-# detect broken links
-
-```
-wget -o 404.txt -r  --spider http://localhost:1313
-```
+Both `publish` and `development-publish` branches are protected. Changes cannot be pushed into them directly.
+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.    
+          
+![no fw api changes](static/github/nonFwChanges.jpg)
+
+### Adding development firmware API changes
+This workflow will be probably done by someone from Pycom firmware development team.
+In this case, Pycom development docs https://development.pycom.io/ needs to be updated with API changes from development firmware.
+
+Note: we are running https://docs.pycom.io and https://development.pycom.io
+When a user clicks on development dropdown on any firmware API change, he/she will be redirected to https://development.pycom.io
+
+    $ 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.    
+
+![fw api changes](static/github/devFwChanges.jpg)
+
+### Adding changes from "publish" branch to "development-publish" branch
+In this case, you want to sync "development" version of docs with the "stable" docs.
+
+    $ git checkout development-publish
+    $ git pull
+    $ git checkout publish
+    $ 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.    
+
+![alt text](static/github/fromPublishToDevelopmentPublish.jpg)
+
+### Adding changes from "development-publish" to "publish" (when development FW API becomes stable FW API)
+In this case, you want to add changes from development firmware API to stable docs.
+
+    $ git checkout publish
+    $ git pull
+    $ git checkout development-publish
+    $ 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 **publish** branch as a base branch.    
+
+![alt text](static/github/fromDevelopmentPublishToPublish.jpg)
+
+## some info:
+
+- assets are in ./static directory, a directory aliased at /
+- css in /themes/doc-theme/static/doc-theme.css
+- SUMMARY.md is in config.toml
+- [gohugo.io](gohugo.io)
+
+## detect broken links
+
+```
+wget -o 404.txt -r  --spider http://localhost:1313
+```