Add documentation on manually triggering a ReleasePlan #268
Conversation
|
🚀 Preview is available at https://pr-268--boisterous-meerkat-894982.netlify.app |
|
🚀 Preview is available at https://pr-268--boisterous-meerkat-894982.netlify.app |
dirgim
requested review from
jseseCCS,
gtrivedi88,
Chr1st1anSears,
scoheb and
davidmogar
| kind: Release | ||
| metadata: | ||
| annotations: | ||
| pac.test.appstudio.openshift.io/event-type: push |
|
The redhat-appstudio docs are deprecated. Would you be able to recreate a similar PR on konflux-ci/docs? |
| @@ -0,0 +1,56 @@ | |||
| = Manually Triggering a ReleasePlan | |||
|
|
|||
| This document covers the process to manually trigger a ReleasePlan for a given Snapshot of an Application when using Konflux. Common use cases include re-releasing a snapshot that failed to release due to a now-resolved condition or in the case that a ReleasePlan is not automatically triggered on every Snapshot intentionally to enforce manual releases (see: Releases to Production Registries that happen infrequently). | |||
There was a problem hiding this comment.
This is all great info, and it's super helpful to have use cases. But I recommend breaking it up into shorter sentences to not overwhelm readers, and rephrasing a bit for clarity:
"One common use case for this procedure is re-releasing a snapshot that failed to release due to an issue that has been resolved. Another use case is when manual releases are mandatory, because ReleasePlans are not automatically triggered on every snapshot. (See: Releases to production registries that happen infrequently)."
Also, should that sentence in the parentheses have a link to something? ^^
| * CLI Access to the Konflux Instance and Namespace that houses the Application and resources | ||
| * A minimum of Maintainer access to the Workspace/Namespace that houses the Application and ReleasePlan | ||
| * [Optional] Contributor (Viewer) access to the Release Engineering namespace that houses the ReleasePlanAdmission for the Application in question | ||
|
|
There was a problem hiding this comment.
As a general rule, Red Hat/IBM encourage us to minimize capitalization, because the industry tendency is to do the opposite. In these prerequisites, the only things that I would leave capitalized are "Konflux", "ReleasePlan," and "ReleasePlanAdmission." Product names are capitalized, and objects written in camel case are kept that way. Everything else should probably be lower case 👍
There was a problem hiding this comment.
| <.> The number of days the Release object should be preserved. | ||
| <.> The name of the ReleasePlan that should be used. | ||
| <.> The name of the Snapshot to Release. | ||
|
|
There was a problem hiding this comment.
So in lines 36-40, I suggest leaving only "ReleasePlan" capitalized
|
@gurnben , I recently added https://konflux-ci.dev/docs/advanced-how-tos/releasing/create-release/ Can you see if you can instead add to that page if any further clarification is needed? |
Summary of Changes
This PR adds documentation on how to manually trigger a Release of a Snapshot!