docs/deployment: add generic deployment workflow #332
Conversation
|
| @@ -85,6 +85,11 @@ const sidebars = { | |||
| }, | |||
| ] | |||
| }, | |||
| { | |||
There was a problem hiding this comment.
I'm not sure if this should be its own top-level section.
We'll probably add more operations that are similar to this.
For example, updating a deployment etc.
Should we have a "Workflow" section similar to Constellation or split the "Workflow" section into multiple logical groups?
There was a problem hiding this comment.
I think we can add a section for it as soon as we have a second page to go into that section? A section with a single page doesn't make much sense imo.
I'm not sure about splitting the workflow into multiple documents at this point, discussed that with @malt3 yesterday. On the one hand, we want to have a concise description of what to do to get your workflows running with Contrast, consisting of the required steps. On the other hand, we might want to give deeper background on single steps and present different alternatives or ways of doing things, leading to a format where reading is more focused than doing.
There was a problem hiding this comment.
Okay let's add sections on the fly and keep one workflow section that includes entire procedures such as an update or a recovery.
Signed-off-by: Paul Meyer <[email protected]>
This page describes the workflow of deploying a generic workload with Contrast. It was previously part of the README (but I've also changed some parts). I moved it after the example section, as the examples are simpler to follow for a first time user, so they should be encountered first in the user journey.