-
Epic
-
Resolution: Unresolved
-
Undefined
-
None
-
None
-
None
-
None
-
Docs for upstream OLM and SDK sites
-
False
-
False
-
Done
-
Impediment
-
0% To Do, 0% In Progress, 100% Done
-
Undefined
-
L
This is an effort to improve the existing OLM upstream documentation, site navigation, look and feel, and search functionality found at olm.operatorframework.io and sdk.operatorframework.io.
Epic Goal
- To allow end users (Cluster admins and Operator Developers) of OLM and SDK to easily get up to speed on key concepts and re-occuring tasks.
Why is this important?
- To increase adoption and day to day use of OLM and SDK
Acceptance Criteria
- CI - MUST be running successfully with tests automated
- Release Technical Enablement - Provide necessary release enablement details and documents.
- Easily organize and navigate from OLM to SDK from top level menus and throughout docs
- Improve and implement Algolia for Search on OLM and SDK
- Ensure look and feel is consistent on each site including same fonts, headings, links, and paragraph sections, color schemes, logos and image assets
Done Checklist
- CI - CI is running, tests are automated and merged.
- DEV - Upstream documentation, code and tests merged: https://github.com/operator-framework/operator-sdk/milestone/12
- incorporates
-
OCPPLAN-7772 Improve upstream OLM documentation
-
- New
-
1.
|
Docs Tracker |
|
Closed | |
Unassigned |
2.
|
QE Tracker |
|
Closed | |
Unassigned |
3.
|
TE Tracker |
|
Closed | |
Unassigned |