reference: snap lifecycle documentation#78
Conversation
4c0ce31 to
8e13305
Compare
8e13305 to
fbd0f3e
Compare
AnneCYH
left a comment
There was a problem hiding this comment.
Hi @awhitcroft , apologies for the delay.
I left some comments but they are mostly suggestions about the formatting; less concerns about the content.
Thanks!
docs/reference/index.md
Outdated
| ``` | ||
|
|
||
| ```{toctree} | ||
| :maxdepth: 2 |
There was a problem hiding this comment.
Hi @awhitcroft , was there a reason for setting :maxdepth: 2 here?
For landing pages I would suggest keeping it clean and just having the title displayed.
docs/reference/snap-lifecycle.rst
Outdated
| @@ -0,0 +1,150 @@ | |||
| ************** | |||
| Snap Lifecycle | |||
There was a problem hiding this comment.
| Snap Lifecycle | |
| Snap lifecycle |
Ubuntu style guide recommends we use sentence case headings. Same comment for the rest of the doc.
https://docs.ubuntu.com/styleguide/en/#headings
Thanks.
docs/reference/snap-lifecycle.rst
Outdated
| Snap Lifecycle | ||
| ************** | ||
|
|
||
| Snap Build Lifecycle |
There was a problem hiding this comment.
| Snap Build Lifecycle | |
| Snap build lifecycle |
| ************** | ||
| Snap Lifecycle | ||
| ************** | ||
|
|
There was a problem hiding this comment.
| This guide describes the build and workflow lifecycle of kernel snaps. |
Ubuntu style guide also advises against stacked headings, e.g. headings need to be followed by content.
https://docs.ubuntu.com/styleguide/en/#headings
docs/reference/snap-lifecycle.rst
Outdated
| Background | ||
| ---------- | ||
| The majority of kernels with snaps are consumed both as Debian packages and | ||
| those snaps. To reduce testing requirements and streamline production the same |
There was a problem hiding this comment.
| those snaps. To reduce testing requirements and streamline production the same | |
| snaps. To reduce testing requirements and streamline production, the same |
| Testing | ||
| ------- |
There was a problem hiding this comment.
| Testing | |
| ------- | |
| Testing | |
| ------- | |
docs/reference/snap-lifecycle.rst
Outdated
| QA Testing | ||
| ---------- |
There was a problem hiding this comment.
| QA Testing | |
| ---------- | |
| QA testing | |
| ---------- | |
docs/reference/snap-lifecycle.rst
Outdated
|
|
||
| QA Testing | ||
| ---------- | ||
| Once we have a formal canidate snap this may be sent for further acceptance |
There was a problem hiding this comment.
| Once we have a formal canidate snap this may be sent for further acceptance | |
| Once we have a formal candidate snap this may be sent for further acceptance |
| Release | ||
| ------- |
There was a problem hiding this comment.
| Release | |
| ------- | |
| Release | |
| ------- | |
docs/reference/snap-lifecycle.rst
Outdated
| with the promotion of the Debian package to ``updates``. The Debian package my | ||
| then promote further to ``security`` but there is no equivalent channel for |
There was a problem hiding this comment.
| with the promotion of the Debian package to ``updates``. The Debian package my | |
| then promote further to ``security`` but there is no equivalent channel for | |
| with the promotion of the Debian package to ``updates``. The Debian package | |
| may then promote further to ``security`` but there is no equivalent channel for |
AnneCYH
left a comment
There was a problem hiding this comment.
Hi @awhitcroft , apologies for the delay.
I left some comments but they are mostly suggestions about the formatting; less concerns about the content.
Thanks!
|
There are also a few words that need to be added to Thanks! |
docs/reference/snap-lifecycle.rst
Outdated
| parameterises the snapcraft.yaml configuration, and kicks off builds against | ||
| the appropriate snap build recipe. This causes the kernel to be processed into | ||
| a snap and uploaded to the snap-store. The store will automatically publish this | ||
| onto the ``edge`` channel for testing. |
There was a problem hiding this comment.
If there are test failures for the snap in "edge", does that gate the progress of the Debian package to "proposed"?
9d630ac to
b7c731e
Compare
Signed-off-by: Andy Whitcroft <apw@canonical.com>
e1946d8 to
503e40d
Compare
AnneCYH
left a comment
There was a problem hiding this comment.
thanks for this @awhitcroft !
Initial documentation for the Snap lifecycles. This include the build lifecycle and the workflow lifecycle.