diff --git a/README.md b/README.md index e4f6c27..bbc5b8b 100644 --- a/README.md +++ b/README.md @@ -7,17 +7,15 @@ hugo serve # Workflow -- Make PR using Master branch -- PR get merged on master -- Then merge publish with master +## 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 -``` -git commit -m "section: commit message" -git push origin master -git checkout publish -git merge master -git push origin publish -``` +## Deploy changes +- Make PR from `master` against `publish` branch +- Assign a reviewer and let your PR to be merged +- docs were updated # some infos: diff --git a/config.toml b/config.toml index d7601ba..3bc7ee4 100644 --- a/config.toml +++ b/config.toml @@ -1194,6 +1194,27 @@ theme = "doc-theme" parent = "pybytes@connect@sigfox" weight = 20 +[[menu.main]] + name = "Project Releases" + url = "/pybytes/releases/" + identifier = "pybytes@releases" + parent = "pybytes" + weight = 20 + +[[menu.main]] + name = "Create new release" + url = "/pybytes/releases/new/" + identifier = "pybytes@releases@new" + parent = "pybytes@releases" + weight = 20 + +[[menu.main]] + name = "Deploy release" + url = "/pybytes/releases/deploy/" + identifier = "pybytes@releases@deploy" + parent = "pybytes@releases" + weight = 20 + [[menu.main]] name = "Visualise data from your device" url = "/pybytes/dashboard/" diff --git a/content/pybytes/releases/_index.md b/content/pybytes/releases/_index.md new file mode 100644 index 0000000..913e8fd --- /dev/null +++ b/content/pybytes/releases/_index.md @@ -0,0 +1,19 @@ +--- +title: "Pybytes Project Releases" +aliases: +--- + +### What is the release? +Each **Pybytes** project contains list of devices. You can update the devices **code**, **network configurations** and/or **firmware version** using a **release** version. + +### What is included in the release? +Each **Release** can contains one or more of the following: + +1. Network configurations settings +2. firmware version +3. MicroPython code +4. release description + +### Release Versioning +1. **Pybytes** increment release version by **one** each time a release is created in the project. **1** is the first release version. +2. Project is limited to **10** Releases. _oldest release will be removed when you create more than 10 releases_ diff --git a/content/pybytes/releases/deploy.md b/content/pybytes/releases/deploy.md new file mode 100644 index 0000000..cfd9db0 --- /dev/null +++ b/content/pybytes/releases/deploy.md @@ -0,0 +1,19 @@ +--- +title: "Deploy Release" +aliases: +--- + +In this section, we will explain how to deploy a release. + + +## Deploy Release Steps + +In Pybytes, go to *Applications* -> *My applications* -> *select target application* -> *Releases* Page: + +1. *Select* target release by clicking *the three dots point* and Click on *Deploy*. +![](/gitbook/assets/pybytes/releases/create-release-step-11.png) + +2. You will get a list of all the devices within the application. + ![](/gitbook/assets/pybytes/releases/create-release-step-12.png) + * Select target devices + ![](/gitbook/assets/pybytes/releases/create-release-step-13.png) diff --git a/content/pybytes/releases/new.md b/content/pybytes/releases/new.md new file mode 100644 index 0000000..4acd1a8 --- /dev/null +++ b/content/pybytes/releases/new.md @@ -0,0 +1,47 @@ +--- +title: "Create New Release" +aliases: +--- + +In this section, we will explain how to create a new release. + + +## Create release wizard + +In Pybytes, go to *Applications* -> *My applications* -> *select target application* -> *Releases* Page: + +1. Click on *Create Release*. +![](/gitbook/assets/pybytes/releases/create-release-step-1.png) + +2. A list of pre-configured application configurations will be shown. +![](/gitbook/assets/pybytes/releases/create-release-step-2.png) + +3. Select the target firmware, or omit this step. +![](/gitbook/assets/pybytes/releases/create-release-step-3.png) + +4. If you want to include code changes in this release you can: + * Check _Upload the code_ **checkbox**. + * Browse your target code (should be a **zip** file) + * The **zip** file size is limited to **4MB** +![](/gitbook/assets/pybytes/releases/create-release-step-7.png) + * Download and extend example release zip archive **[my-release.zip](/gitbook/assets/pybytes/releases/code-example/my-code.zip)** + * Or create a zip file with the following structure: + ``` + my_release.zip + ├── flash <-- updates files on the /flash partition + │ └── main.py + │ └── my_awesome_module.py + │ └── ... + └── sd <-- updates files on the MicroSD card + └── my_another_awesome_module.py + └── ... + ``` + +5. *Write* a description for this release. +![](/gitbook/assets/pybytes/releases/create-release-step-8.png) + +6. *Review* release details then *Click* Finish. +![](/gitbook/assets/pybytes/releases/create-release-step-9.png) + +7. You can see a list of created releases under the **Releases** tab. +![](/gitbook/assets/pybytes/releases/create-release-step-10.png) diff --git a/static/gitbook/assets/pybytes/releases/code-example/my-code.zip b/static/gitbook/assets/pybytes/releases/code-example/my-code.zip new file mode 100644 index 0000000..cf2d5d6 Binary files /dev/null and b/static/gitbook/assets/pybytes/releases/code-example/my-code.zip differ diff --git a/static/gitbook/assets/pybytes/releases/create-release-step-1.png b/static/gitbook/assets/pybytes/releases/create-release-step-1.png new file mode 100644 index 0000000..8c2108d Binary files /dev/null and b/static/gitbook/assets/pybytes/releases/create-release-step-1.png differ diff --git a/static/gitbook/assets/pybytes/releases/create-release-step-10.png b/static/gitbook/assets/pybytes/releases/create-release-step-10.png new file mode 100644 index 0000000..2e968eb Binary files /dev/null and b/static/gitbook/assets/pybytes/releases/create-release-step-10.png differ diff --git a/static/gitbook/assets/pybytes/releases/create-release-step-11.png b/static/gitbook/assets/pybytes/releases/create-release-step-11.png new file mode 100644 index 0000000..820e2a9 Binary files /dev/null and b/static/gitbook/assets/pybytes/releases/create-release-step-11.png differ diff --git a/static/gitbook/assets/pybytes/releases/create-release-step-12.png b/static/gitbook/assets/pybytes/releases/create-release-step-12.png new file mode 100644 index 0000000..b4afd3e Binary files /dev/null and b/static/gitbook/assets/pybytes/releases/create-release-step-12.png differ diff --git a/static/gitbook/assets/pybytes/releases/create-release-step-13.png b/static/gitbook/assets/pybytes/releases/create-release-step-13.png new file mode 100644 index 0000000..bbb6151 Binary files /dev/null and b/static/gitbook/assets/pybytes/releases/create-release-step-13.png differ diff --git a/static/gitbook/assets/pybytes/releases/create-release-step-2.png b/static/gitbook/assets/pybytes/releases/create-release-step-2.png new file mode 100644 index 0000000..efbfa0c Binary files /dev/null and b/static/gitbook/assets/pybytes/releases/create-release-step-2.png differ diff --git a/static/gitbook/assets/pybytes/releases/create-release-step-3.png b/static/gitbook/assets/pybytes/releases/create-release-step-3.png new file mode 100644 index 0000000..2e7f492 Binary files /dev/null and b/static/gitbook/assets/pybytes/releases/create-release-step-3.png differ diff --git a/static/gitbook/assets/pybytes/releases/create-release-step-7.png b/static/gitbook/assets/pybytes/releases/create-release-step-7.png new file mode 100644 index 0000000..e4b7aaf Binary files /dev/null and b/static/gitbook/assets/pybytes/releases/create-release-step-7.png differ diff --git a/static/gitbook/assets/pybytes/releases/create-release-step-8.png b/static/gitbook/assets/pybytes/releases/create-release-step-8.png new file mode 100644 index 0000000..b295853 Binary files /dev/null and b/static/gitbook/assets/pybytes/releases/create-release-step-8.png differ diff --git a/static/gitbook/assets/pybytes/releases/create-release-step-9.png b/static/gitbook/assets/pybytes/releases/create-release-step-9.png new file mode 100644 index 0000000..7e04736 Binary files /dev/null and b/static/gitbook/assets/pybytes/releases/create-release-step-9.png differ