docs: working with stages documentation #2608
Conversation
✅ Deploy Preview for docs-kargo-akuity-io ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2608 +/- ##
==========================================
+ Coverage 51.35% 51.40% +0.04%
==========================================
Files 287 288 +1
Lines 26022 26100 +78
==========================================
+ Hits 13363 13416 +53
- Misses 11938 11959 +21
- Partials 721 725 +4 ☔ View full report in Codecov by Sentry. |
fykaa
force-pushed
the
docs-kargo-verify-command
branch
from
23c0239 to
2410cc3
Compare
|
This feels misplaced. Scanning the rest of the concepts doc, there are no other occurrences of demonstrating CLI commands. I think we should keep this page focused on concepts and how they map to CRDs. This raises the question of where this documentation of |
✅ Deploy Preview for docs-kargo-io ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
fykaa
force-pushed
the
docs-kargo-verify-command
branch
from
f28e5bd to
b012ab9
Compare
| kargo verify stage --project=<project-name> <stage-name> | ||
| ``` | ||
|
|
||
| 2. To stop an ongoing verification process, use: |
There was a problem hiding this comment.
This is awkward. It's being presented as:
Step 1: Start verification
Step 2: Abort it
Those feel like two different things, rather than elements of the same sequence.
This also differs from the UI-centric instructions above, which didn't talk about aborting a verification, but went from starting one to showing how you can see which Stages a piece of Freight has been verified in.
We should try to keep things consistent and have the UI and CLI tabs cover the same things in the same order.
There was a problem hiding this comment.
I agree, I’ll updated the 'Reverifying a Stage’s Current Freight' section to align the UI and CLI instructions to only include a subtle guidance on aborting verification, and a CLI command to check verified stages. It should be now consistent with the UI tab
Signed-off-by: Kent Rancourt <[email protected]> Apply suggestions from code review Signed-off-by: Kent Rancourt <[email protected]> Apply suggestions from code review Signed-off-by: Kent Rancourt <[email protected]> Apply suggestions from code review Signed-off-by: Kent Rancourt <[email protected]>
fykaa
force-pushed
the
docs-kargo-verify-command
branch
2 times, most recently
from
907eefb to
cbf092b
Compare
Signed-off-by: Faeka Ansari <[email protected]>
fykaa
force-pushed
the
docs-kargo-verify-command
branch
from
cbf092b to
8c63c12
Compare
|
|
||
|  | ||
|
|
||
| If you want to stop the verification process mid-way, you can click the <Hlt>Abort Verification</Hlt> button next to the Reverify option. |
There was a problem hiding this comment.
| If you want to stop the verification process mid-way, you can click the <Hlt>Abort Verification</Hlt> button next to the Reverify option. | |
| :::note | |
| If you wish to stop the in-progress verification, you can click <Hlt>Abort Verification</Hlt>. | |
| ::: |
| :::note | ||
| For detailed instructions on promoting a `Stage`, refer to the Working with Promotions page. | ||
| ::: |
There was a problem hiding this comment.
I think this little bit here is going to be much too-easily overlooked.
I think I would carve out a separate ###-level section under Interacting with Stages -- fairly high up as well -- probably right after the section with instructions for creating a stage.
The section doesn't really need much more detail than what you've got in this note box here.
The point is that I just want this reference to the Promotion docs page in a more prominent place.
Nit on "promoting": Promotions require a pair of arguments. "Promoting a Stage" therefore doesn't make sense. So when you move this, please also consider rewording to be inclusive of both equally important arguments. Something like: "For detailed instructions for promoting Freight to a Stage...
fixes #2339