Skip to content

FLPATH-4135 | Create documentation for DCM UI#16

Merged
gciavarrini merged 3 commits into
dcm-project:mainfrom
asmasarw:feature/dcm-ui
Jun 4, 2026
Merged

FLPATH-4135 | Create documentation for DCM UI#16
gciavarrini merged 3 commits into
dcm-project:mainfrom
asmasarw:feature/dcm-ui

Conversation

@asmasarw

@asmasarw asmasarw commented May 26, 2026

Copy link
Copy Markdown
Contributor

Summary by Sourcery

Add user-facing documentation for the DCM web UI and link it from existing user guide entry points.

Documentation:

  • Document the DCM Backstage-based web UI, including common patterns and per-tab behavior for managing DCM resources.
  • Update user guide landing pages to describe managing DCM resources via either the CLI or the web UI, and link to the new UI documentation.
image

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

i think some UI screenshots would simplify the understanding for the reader.
WDYT?

so the user know what to expect instead of imagine "the render" from the descriptions

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.

Added

weight: 8
---

The DCM UI is a [Backstage](https://backstage.io/) plugin that provides a web interface for managing DCM resources. It offers the same resource management capabilities as the CLI, presented as interactive data tables with inline search, pagination, and action buttons.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

nit: instead of long lines, i suggest wrapping at 80 chars so reviews and edits are easier.

Comment thread content/docs/user-guide/ui.md Outdated
@chadcrum chadcrum requested a review from hardengl May 27, 2026 14:27
@gciavarrini gciavarrini requested a review from y-first June 3, 2026 07:13
asmasarw added 3 commits June 4, 2026 09:55
Signed-off-by: Ashraf Masarwa <asmasarw@redhat.com>
Signed-off-by: Ashraf Masarwa <asmasarw@redhat.com>
Signed-off-by: Ashraf Masarwa <asmasarw@redhat.com>

@gciavarrini gciavarrini left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

lgtm

@gciavarrini gciavarrini merged commit 0e83a3b into dcm-project:main Jun 4, 2026
2 checks passed
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.

4 participants