Skip to content

docs: mention DWO_NAMESPACE env var in backup docs#3059

Open
dkwon17 wants to merge 1 commit intoeclipse-che:mainfrom
dkwon17:backup-namespace
Open

docs: mention DWO_NAMESPACE env var in backup docs#3059
dkwon17 wants to merge 1 commit intoeclipse-che:mainfrom
dkwon17:backup-namespace

Conversation

@dkwon17
Copy link
Copy Markdown
Contributor

@dkwon17 dkwon17 commented Mar 31, 2026

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.

  • Any procedure:
    • Successfully tested.
  • Any page or link rename:
    • The page contains a redirection for the previous URL.
    • Propagate the URL change in:
  • Builds on Eclipse Che hosted by Red Hat.
  • the Validate language on files added or modified step reports no vale warnings.

@dkwon17 dkwon17 requested a review from l0rd March 31, 2026 20:01
@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 31, 2026

Click here to review and test in web IDE: Contribute

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 31, 2026

🎊 Navigate the preview: https://69cc31c89ac3e4147cb2f958--eclipse-che-docs-pr.netlify.app 🎊

Signed-off-by: dkwon17 <dakwon@redhat.com>
- env:
- name: DWO_NAMESPACE
value: $OPERATOR_INSTALL_NAMESPACE
name: che-dashboard
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This value is the same for both upstream and downstream.

Copy link
Copy Markdown
Contributor

@gtrivedi88 gtrivedi88 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding the DWO_NAMESPACE documentation — this is useful context for non-default operator installations.

A few CQA/style issues to address:

  1. Bold pseudo-heading**Note:** must be a proper [NOTE] admonition block (DITA compatibility, Vale BlockTitle rule)
  2. Bare placeholder$OPERATOR_INSTALL_NAMESPACE in the snippet has no explanation; the reader needs guidance on what value to substitute
  3. Snippet placement — In the regular OCI registry file, the include breaks the flow between the callout and authSecret explanation; consider moving it to the end
  4. 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.
Copy link
Copy Markdown
Contributor

@gtrivedi88 gtrivedi88 Apr 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Copy Markdown
Contributor

@gtrivedi88 gtrivedi88 Apr 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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[]
Copy link
Copy Markdown
Contributor

@gtrivedi88 gtrivedi88 Apr 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
----
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants