feat: adjust the docs to the current Orchestrator functionality #2499
Conversation
TheMeaningfulEngineer
requested review from
estenberg,
michaelntech and
jo-lund
There was a problem hiding this comment.
First off, do you know how docs gets merged to stable these days? This is great to have in master for now and iterate over, but we should not merge it into the stable / default docs site.
A few nitpicks here, overall:
- Names are Capital Case. For example, Mender Client, Orchestrator, Manifest, Artifact, etc.
- We need to define such new concepts clearly (one sentence) and add them to Taxonomy.
- Separate examples from Concepts
- There are some unrelated changes included in the PR
09.Add-ons/05.Orchestrator/docs.md
Outdated
|
|
||
|
|
||
|
|
||
| ### Update interface |
There was a problem hiding this comment.
Interface.
By the way, didn't we rename this to just "Interface" now? (drop Update)? Check the Epic.. there are at least some tasks for that.
Also should go in Taxonomy.
There was a problem hiding this comment.
We need to rename this repo as well then https://github.com/mendersoftware/mender-orchestrator-update-interfaces
There was a problem hiding this comment.
Right, actually it's not done but tracked here: https://northerntech.atlassian.net/browse/MEN-7505
I guess you can use the old name for now then, until that task is done. Up to you.
| @@ -24,7 +24,7 @@ mkfifo /data/mender/dump | |||
| mender-snapshot dump > /data/mender/dump | |||
| ``` | |||
|
|
|||
| Then, back to the shell on the host where you have the variables form the Get Started guide, run: | |||
| The last command will not terminate, but will wait for you to execute commands from the host. So back in the shell on the host where you have the variables form the Get Started guide, run: | |||
There was a problem hiding this comment.
Would split to separate PR.
| @@ -36,6 +36,8 @@ mender-artifact write rootfs-image \ | |||
| -f rootfs.ext4 | |||
| ``` | |||
|
|
|||
| While the command is running, you should see a progress bar in the device window. | |||
There was a problem hiding this comment.
Would split to separate PR.
Then we should merge this into a feature branch 👌 |
|
Found a few small typos to fix. |
Tickets: MEN-6996 MEN-7016 CE-447 Signed-off-by: Alan <[email protected]> Signed-off-by: Kristian Amlie <[email protected]>
TheMeaningfulEngineer
force-pushed
the
feature-orchestrator
branch
from
ad38e1f to
b88494f
Compare
Tickets: MEN-6996 MEN-7016 CE-447
Examples work once mendersoftware/mender-orchestrator-update-interfaces#7 is merged