Skip to content

docs: Document mount-to-devworkspace-include/exclude annotations#3089

Merged
tolusha merged 2 commits into
mainfrom
docs/mount-to-devworkspace-include-exclude
May 12, 2026
Merged

docs: Document mount-to-devworkspace-include/exclude annotations#3089
tolusha merged 2 commits into
mainfrom
docs/mount-to-devworkspace-include-exclude

Conversation

@tolusha
Copy link
Copy Markdown
Contributor

@tolusha tolusha commented May 7, 2026

What does this pull request change?

Documents the new controller.devfile.io/mount-to-devworkspace-include and controller.devfile.io/mount-to-devworkspace-exclude annotations introduced in devfile/devworkspace-operator#1619. These annotations allow mounting ConfigMaps, Secrets, and PVCs only to specific DevWorkspaces by name pattern.

Updated articles:

  • mounting-secrets.adoc — Added include/exclude annotations to the Optional annotations table
  • mounting-configmaps.adoc — Added include/exclude annotations to the Optional annotations table
  • configuring-a-user-namespace.adoc — Restructured annotation docs as tables (replacing inline YAML blocks) and added include/exclude annotations for ConfigMap, Secret, and PVC sections

What issues does this pull request fix or reference?

Specify the version of the product this pull request applies to

next

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.

Add documentation for the new `controller.devfile.io/mount-to-devworkspace-include`
and `controller.devfile.io/mount-to-devworkspace-exclude` annotations that allow
mounting ConfigMaps, Secrets, and PVCs only to specific DevWorkspaces by name pattern.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@tolusha tolusha requested a review from svor May 7, 2026 07:44
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 7, 2026

🎊 Navigate the preview: https://6a02d8b780b14b2a7b9046cd--eclipse-che-docs-pr.netlify.app 🎊

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 7, 2026

Click here to review and test in web IDE: Contribute

@tolusha
Copy link
Copy Markdown
Contributor Author

tolusha commented May 7, 2026

@gtrivedi88 Could you review pls?

1 similar comment
@tolusha
Copy link
Copy Markdown
Contributor Author

tolusha commented May 11, 2026

@gtrivedi88 Could you review pls?

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.

Documentation Review

Files reviewed: 3 modified documentation files
Issues found: 6 (2 errors, 3 warnings, 1 suggestion)

Category Count
AsciiDoc syntax errors (build-breaking) 2
Information loss (removed WARNING) 1
Technical completeness gaps 2
Wording inconsistency 1

The restructuring from inline YAML blocks to tables is a clear improvement in scannability. Annotation descriptions are technically accurate against the source implementation.

🤖 RHAI docs Claude Code review

Comment thread modules/administration-guide/pages/configuring-a-user-namespace.adoc Outdated
Comment thread modules/end-user-guide/pages/mounting-configmaps.adoc Outdated
Comment thread modules/administration-guide/pages/configuring-a-user-namespace.adoc Outdated
Comment thread modules/administration-guide/pages/configuring-a-user-namespace.adoc Outdated
Signed-off-by: Anatolii Bazko <abazko@redhat.com>
@tolusha
Copy link
Copy Markdown
Contributor Author

tolusha commented May 12, 2026

@gtrivedi88
Addresses all remarks.

@tolusha tolusha merged commit 95402ae into main May 12, 2026
11 checks passed
@tolusha tolusha deleted the docs/mount-to-devworkspace-include-exclude branch May 12, 2026 07:16
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.

2 participants