Imported wiki (#2)

* imported wiki

* updated image paths

* .

Co-authored-by: CaCO3 <caco@ruinelli.ch>
This commit is contained in:
CaCO3
2023-01-03 00:05:31 +01:00
committed by GitHub
parent 5e61cd1ce3
commit e3ce23a844
80 changed files with 2407 additions and 6 deletions

17
docs/Release-creation.md Normal file
View File

@@ -0,0 +1,17 @@
## Preparing for release
1. [Changelog](https://github.com/jomjol/AI-on-the-edge-device/blob/rolling/Changelog.md) is merged back from `master` branch to `rolling` branch (should be the last step of the previous release creation)
1. All changes are documented in the [Changelog](https://github.com/jomjol/AI-on-the-edge-device/blob/rolling/Changelog.md) in `rolling` branch
## Release creation steps
1. Merge`rolling` into `master` branch
2. Best to wait for the GitHub action to run successfully
3. On `master` branch tag the version like `v11.3.1` and don't forget to push it.
4. Wait for the GitHub-Action of release creation. After all is done:
* the release should be created
* the artifacts are downloadable from release
* The documented changes were applied to the release
5. Merge master back in `rolling`
1. In `rolling` create a folder `rolling/docs/releases/download/<VERSION>` and add the `firmware.bin` from one of the release artifacts.
1. Update `rolling/docs/manifest.json` with the new version (update the `version` and the last `path` fields)