Skip to content
This repository has been archived by the owner on Feb 17, 2022. It is now read-only.

[Meta] Update docs outline #39

Open
scottrigby opened this issue Jun 25, 2021 · 0 comments
Open

[Meta] Update docs outline #39

scottrigby opened this issue Jun 25, 2021 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@scottrigby
Copy link
Contributor

scottrigby commented Jun 25, 2021

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.

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)
@scottrigby scottrigby added the enhancement New feature or request label Jun 25, 2021
@scottrigby scottrigby changed the title Update docs outline [Meta] Update docs outline Jul 8, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants