[jenniferubah]

Summary:

• Replace the Providers CLI guide with an Agents guide covering dcm agent list/get, health status, and self-registration
• Update the UI docs and user-guide cross-links to match the Agents model

Fixes: https://redhat.atlassian.net/browse/FLPATH-4947

Assisted-By: Cursor AI

Summary by Sourcery

Replace the Providers documentation with comprehensive environment-agent guidance across the CLI and UI user guides.

New Features:

• Add a user guide for environment agents covering listing, details, health statuses, filtering, pagination, and self-registration.

Enhancements:

• Replace provider terminology and references with the environment-agent model across the user guide and UI documentation.
• Update the UI guide to describe agent fields, health information, and manual registration as an alternative to self-registration.

Documentation:

• Update user-guide navigation and cross-links to point to the Agents guide and agent-based resource relationships.

Chores:

• Remove the obsolete Providers user guide.

[qodo-code-review]

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Tip of the day

💡 Did you know, you can switch off images and animations for a plain-text comment

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

[qodo-code-review]

PR Summary by Qodo

Replace provider user guide with environment agent guidance

📝 Documentation 🕐 10-20 Minutes

AI Description

• Replace the Providers CLI guide with agent listing, details, health, and registration guidance.
• Describe the Agents UI tab and update user-guide links to the agent model.

Diagram

graph TD
  Guide["User guide"] --> Agents["Agents guide"] --> UI["UI guide"]
  Types["Service types"] --> Agents
  Resources["SP resources"] --> Agents

Loading

High-Level Assessment

Replacing the obsolete guide and updating its direct cross-links is appropriate for a documentation-only transition. Keeping a parallel Providers guide would obscure which model readers should use; verify the remaining provider screenshot and UI wording before publishing.

Files changed (5) +125 / -28

Documentation (5) +125 / -28

_index.mdPoint the user-guide index to Agents +2/-2

Point the user-guide index to Agents

• Replaces the Providers entry with a link describing registered environment agents and their health.

content/docs/user-guide/_index.md

agents.mdDocument environment agents and read-only CLI commands +97/-0

Document environment agents and read-only CLI commands

• Adds examples for listing and getting agents, health filtering, pagination, and JSON details. Explains self-registration, heartbeat-based health states, and the UI's manual-registration option.

content/docs/user-guide/agents.md

service-provider-resources.mdLink provisioned resources to the Agents guide +4/-5

Link provisioned resources to the Agents guide

• Changes the introductory link and wording from providers to agents while retaining the KubeVirt resource example.

content/docs/user-guide/service-provider-resources.md

service-types.mdDescribe agents' supported service types +2/-2

Describe agents' supported service types

• Replaces the provider relationship with agents registering support for one or more service types and links to the Agents guide.

content/docs/user-guide/service-types.md

ui.mdDescribe the Agents tab and registration action +20/-19

Describe the Agents tab and registration action

• Replaces the Providers tab's columns and actions with agent fields and manual-registration guidance. Points CLI readers to the Agents guide; the existing provider screenshot remains referenced.

content/docs/user-guide/ui.md

[sourcery-ai]

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

Sourcery assessment

Approved.

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

[y-first]

Nit: superfluous "a", and should be "removed"