-
Feature
-
Resolution: Unresolved
-
Critical
-
None
-
None
-
False
-
-
False
-
0% To Do, 40% In Progress, 60% Done
-
-
Feature Overview (aka. Goal Summary)
RHDH docs need to be restructured to make them user story focused and the content findable. We need the structure to comply with standard guidelines around categories and other doc best practices. We also want to factor in some of the feedback we have received wrt the structure from various stakeholders.
Goals (aka. expected user outcomes)
The observable functionality that the user now has as a result of receiving
this feature. Include the anticipated primary user type/persona and which
existing features, if any, will be expanded.
- Ensure our docs are User story focused
- Make the content findable
- Comply with standard guidelines around categories and other doc best practices
- Factor in stakeholder feedback
Requirements (aka. Acceptance Criteria):
- Create an overall restructure proposal
- Get acks from the docs team stakeholders
- Get cross-functional stakeholder acks
- Divide the work into multiple Jira Epics
- Get peer and SME reviews on PRs addressing those Epics, acks from core docs team focused on Restructure is a must
- Merge and publish
Out of Scope (Optional)
Issues that come up while doing the restructure should be discussed with the team, specially DPM and CS, and we should weigh it together to see if it needs to be done right-away or later as part of backlog. Otherwise there is a great chance of scope creep.
- incorporates
-
RHIDP-4192 [Docs] CX: Create new RHDH Plugins category and titles
- New
-
RHIDP-5138 [Docs] Plugins content improvements
- New
-
RHIDP-5282 [Doc] - CX - Customizing section doc improvement
- New
-
RHIDP-3661 Restructure the Anthentication and Authorization books to follow user journey
- In Progress
-
RHIDP-2632 [DOC] Improve Dynamic Plugins Configuration guide for 1.3
- In Progress
-
RHIDP-3741 [Docs] CX: Create new Observe category and titles
- Closed
-
RHIDP-3742 [Docs] CX: Create new Discover category and titles
- Closed
-
RHIDP-3743 [Docs] CX: Create new Configure category and titles
- Closed
-
RHIDP-2571 [Docs] Restructure: Add Plugins guide as an Additional Resources in the Administration guide
- New
-
RHIDP-3787 CX: Rename configuring plugins guide
- Closed