From 99e6be5840347284ac219a00c24e6cdb9f447a9f Mon Sep 17 00:00:00 2001 From: Ahmad El Masri Date: Thu, 3 Oct 2019 12:36:02 +0200 Subject: [PATCH] docs: create release description page and move new release steps --- config.toml | 9 ++++- content/pybytes/releases/_index.md | 53 +++++++----------------------- content/pybytes/releases/new.md | 48 +++++++++++++++++++++++++++ 3 files changed, 68 insertions(+), 42 deletions(-) create mode 100644 content/pybytes/releases/new.md diff --git a/config.toml b/config.toml index 6abff0e..3bc7ee4 100644 --- a/config.toml +++ b/config.toml @@ -1195,12 +1195,19 @@ theme = "doc-theme" weight = 20 [[menu.main]] - name = "Create new release" + 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/" diff --git a/content/pybytes/releases/_index.md b/content/pybytes/releases/_index.md index 46cac1c..0bd1ebd 100644 --- a/content/pybytes/releases/_index.md +++ b/content/pybytes/releases/_index.md @@ -1,48 +1,19 @@ --- -title: "Create New Release" +title: "Pybytes Project Releases" aliases: --- -In this section, we will explain how to create a new release. +### What is the release? +Each **Pybpytes** 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: -## Create release wizard +1. Network configurations settings +2. firmware version +3. `MicroPython` code +4. release description -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) - * if you need to update files on the device you should follow the structure below. - * `zip` file 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 - └── ... - ``` - * *Check* file structure and code example on the following link: [my-code.zip](/gitbook/assets/pybytes/releases/code-example/my-code.zip) - -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) +### 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/new.md b/content/pybytes/releases/new.md new file mode 100644 index 0000000..46cac1c --- /dev/null +++ b/content/pybytes/releases/new.md @@ -0,0 +1,48 @@ +--- +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) + * if you need to update files on the device you should follow the structure below. + * `zip` file 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 + └── ... + ``` + * *Check* file structure and code example on the following link: [my-code.zip](/gitbook/assets/pybytes/releases/code-example/my-code.zip) + +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)