read-the-docs follow-up

[dholbach]

Following #2152 we should take a look at:

Content

• factor in Hidde's feedback
  • 'Installing Flux' index should contain a section about installing Flux and the Helm operator at the same time, this could be on a new page or we can divide the 'get started' in two sections, one without the operator and one with.
  • I think we should rethink some of the page titles, e.g. we have a top item 'Using Flux' with a 'child page' 'Using Weave Flux'.
  • I think we should rethink some parts of the (naming of the) new structure, e.g, we have a 'introducing Weave Flux' index, but also a 'how Weave Flux Works' index. As a new user, I would expect the introduction to contain the latter, so we may need to rethink the naming, or merge parts.
  • 'Internals' is something that would scare me away as a user, listing the more important features under this index (garbage collection and manifest factorization) will probably reduce the amount of people finding this information by themselves.
• Helm Operator docs should be in a separate dir
• fix references from Weaveworks website

Build

• generally document how to use this

Publish

• pull in older releases
• link to docs from main README.md
• docs.fluxcd.io

[demisx]

Would be also helpful if all links in the Readme were working. Currently, a few of them return 404 Not Found error from GitHub.

[dholbach]

Thanks @demisx for letting us know. Proposed a fix for this in #2307.

[stefanprodan]

@dholbach I think we can close this and open specific issues for dead links if there are any left.

[dholbach]

Big +1. I think we're good for now! :-D