docs: mention DWO_NAMESPACE env var in backup docs#3059
docs: mention DWO_NAMESPACE env var in backup docs#3059dkwon17 wants to merge 1 commit intoeclipse-che:mainfrom
Conversation
|
🎊 Navigate the preview: https://69cc31c89ac3e4147cb2f958--eclipse-che-docs-pr.netlify.app 🎊 |
Signed-off-by: dkwon17 <dakwon@redhat.com>
647ade9 to
f8cd7b1
Compare
| - env: | ||
| - name: DWO_NAMESPACE | ||
| value: $OPERATOR_INSTALL_NAMESPACE | ||
| name: che-dashboard |
There was a problem hiding this comment.
This value is the same for both upstream and downstream.
gtrivedi88
left a comment
There was a problem hiding this comment.
Thanks for adding the DWO_NAMESPACE documentation — this is useful context for non-default operator installations.
A few CQA/style issues to address:
- Bold pseudo-heading —
**Note:**must be a proper[NOTE]admonition block (DITA compatibility, ValeBlockTitlerule) - Bare placeholder —
$OPERATOR_INSTALL_NAMESPACEin the snippet has no explanation; the reader needs guidance on what value to substitute - Snippet placement — In the regular OCI registry file, the include breaks the flow between the callout and
authSecretexplanation; consider moving it to the end - Missing final newline — The snippet file should end with a newline
| @@ -0,0 +1,18 @@ | |||
| :_content-type: SNIPPET | |||
|
|
|||
| **Note:** If the installation {namespace} for the {devworkspace} operator is not `openshift-operators`, you must define it as an environment variable for the {prod} dashboard in the `CheCluster` Custom Resource. | |||
There was a problem hiding this comment.
Replace:
**Note:** If the installation {namespace}...With:
[NOTE]
====
If the installation {namespace} for the {devworkspace} operator is not `openshift-operators`, you must define it as an environment variable for the {prod} dashboard in the `CheCluster` Custom Resource.
[source,yaml,subs="+attributes,+quotes"]
----
...
----
====This wraps both the explanatory text and the YAML example inside a single admonition block, which is the correct AsciiDoc pattern for a note with a code example.
| containers: | ||
| - env: | ||
| - name: DWO_NAMESPACE | ||
| value: $OPERATOR_INSTALL_NAMESPACE |
There was a problem hiding this comment.
Two options:
Option A — Use the formatted replaceable-text convention and add a brief explanation:
value: __<operator_install_namespace>__Then after the source block, add:
where `__<operator_install_namespace>__` is the namespace where the {devworkspace} operator is installed.
Option B — Add a callout marker <1> (matching the pattern already used in the parent files) with an explanation after the source block.
Note: the parent procedure files already use $OPERATOR_INSTALL_NAMESPACE <1> with a callout explaining it's openshift-operators by default. For consistency, this snippet should provide the same guidance since it's a standalone reusable fragment that may be read without the surrounding callout context.
| ---- | ||
| <1> For Red Hat OpenShift, the default installation namespace for the {devworkspace} operator is `openshift-operators`. See the xref:devworkspace-operator.adoc[{devworkspace} operator overview]. | ||
|
|
||
| include::partial$snip_defining-dwo-namespace-for-backups.adoc[] |
There was a problem hiding this comment.
The snippet include is inserted between the callout explanation for <1> (line 34) and the authSecret explanation paragraph (line 38). This breaks the reading flow — the reader goes from a callout about $OPERATOR_INSTALL_NAMESPACE to a note about DWO_NAMESPACE, then back to authSecret details.
Consider moving the include:: to the end of the file (after the WARNING block about secret copying), matching the placement pattern used in devworkspace-backup-integrated-openshift-registry.adoc where it's appended at the very end. This keeps the registry credential setup instructions contiguous.
| - name: DWO_NAMESPACE | ||
| value: $OPERATOR_INSTALL_NAMESPACE | ||
| name: che-dashboard | ||
| ---- |
There was a problem hiding this comment.
Minor: The file should end with a final newline after ---- to comply with .editorconfig (insert_final_newline = true) and prevent AsciiDoc rendering issues when the snippet is included mid-file (as in the regular OCI registry page).
What does this pull request change?
Adds a notice about the DWO_NAMESPACE env var which is needed for the dashboard to detect backup status. This is needed only when the DWO install namespace is not openshift-operators.
What issues does this pull request fix or reference?
Specify the version of the product this pull request applies to
DS 3.27.
Pull Request checklist
The author and the reviewers validate the content of this pull request with the following checklist, in addition to the automated tests.
Validate language on files added or modifiedstep reports no vale warnings.