-
Story
-
Resolution: Done
-
Normal
-
None
-
None
-
None
-
5
-
False
-
-
False
-
-
-
DEVAI Sprint 3283
Story (Required)
As a user of RHDH from Devhub, I would like to use the Lightspeed plugin to query my rhdh-docs techdocs https://gitlab.cee.redhat.com/rhidp/rhdh-team-docs/-/blob/main/catalog-info.yaml?ref_type=heads
Right now, I need to manually navigate the techdocs structure to find the document i am looking for. However with the Lightspeed plugin and Techdocs MCP tool, it can provide me with the doc
Background (Required)
Use the Techdoc MCP tool and rhdh-docs techdoc to showcase how Lightspeed can be used to query the big techdoc selection
Out of scope
<Defines what is not included in this story>
Approach (Required)
In your cluster
- Import rhdh-docs techdoc (it is behind VPN, solve that first) Component to your RHDH Catalog from https://gitlab.cee.redhat.com/rhidp/rhdh-team-docs/-/blob/main/catalog-info.yaml?ref_type=heads
- Install Lightspeed and Techdoc MCP Tool dynamic plugins
- Use Lightspeed to query subject related to rhdh-docs Techdoc
- Share demo recording in Slack channel for dogfooding
Dependencies
<Describes what this story depends on. Dependent Stories and EPICs should be linked to the story.>
Acceptance Criteria (Required)
<Describe edge cases to consider when implementing the story and defining tests>
<Provides a required and minimum list of acceptance tests for this story. More is expected as the engineer implements this story>
documentation updates (design docs, release notes etc)
demo needed
SOP required
education module update (Filled by RHDHPAI team only)
R&D label required (Filled by RHDHPAI team only)
Done Checklist
Code is completed, reviewed, documented and checked in
Unit and integration test automation have been delivered and running cleanly in continuous integration/staging/canary environment
Continuous Delivery pipeline(s) is able to proceed with new code included
Customer facing documentation, API docs, design docs etc. are produced/updated, reviewed and published
Acceptance criteria are met
If the Grafana dashboard is updated, ensure the corresponding SOP is updated as well