This repository was archived by the owner on Feb 17, 2022. It is now read-only.
This repository was archived by the owner on Feb 17, 2022. It is now read-only.
[Meta] Update docs outline #39
Open
Description
This issue is to track desired updates to the top-level docs outline, which was covered in today's meeting with @pzfreo @bia @jrryjcksn @scottrigby.
These issues below are all well-formatted & actionable, so that team members can take them on in parallel. This issue will depend on those others for completion.
- Update intro text #48
- Flesh out Guides #50
- Can/should Weave GitOps manage the CRD lifecycle? If not, how do it's users do that? #51
Outline
Here are maps between the desired and current outlines:
Map: (meeting outline -> to current docs)
- Intro -> introduction
- Start now -> getting started
- Guides -> Examples
- Cli ref -> cli ref
- What’s coming -> add simple language on this to the intro (see far below)
- FAQ -> Need to add
- Follow -> HOLD (can link to Weave GitOps marketing page on WW website when it’s ready)
Map: (current docs -> meeting outline)
- Architecture -> REMOVE for now based on today’s meeting? Concepts are simply added to intro for now
- Troubleshooting -> KEEP as-is. Maybe link to support from there “if you’ve tried all of the above and still have probs, feel free to contact WW support at …”
- Examples -> Guides
- GitOps Automation Configuration -> Getting Started/Configuration (later add to top-level in guides for more advanced configuration, once we have more content for it)