docs: update ToC layout #1633
docs: update ToC layout #1633
Conversation
edvald
force-pushed
the
docs-toc-update
branch
2 times, most recently
from
2487299 to
d323391
Compare
docs/README.md
Outdated
| * [Remote Kubernetes](./guides/remote-kubernetes.md) | ||
| * [Terraform](./guides/terraform.md) | ||
| * [Variables and templating](./guides/variables-and-templating.md) | ||
| * [Advanced](./guides/advanced/README.md) |
There was a problem hiding this comment.
Would it make sense to also have the Advanced section top level? So Guides and Advanced Guides. It's a little hidden like this. I also don't think that Remote Sources should be considered advanced, but perhaps Terraform should.
There was a problem hiding this comment.
That's all debatable. I think remote sources are for sure advanced, but maybe Terraform also. That's all a matter of perspective 🤷♂️
Matters less, of course, if we move the advanced section higher. I do like having this distinction though.
There was a problem hiding this comment.
Yeah I definitely agree we should have an Advanced section. And it can of course be debatable what we put in there. But if it's top level it's at least visible. Do you think we'd have too many top-level sections if we put Advanced Guides there as well?
There was a problem hiding this comment.
I moved them to a top-level Advanced section, and moved Terraform there too.
edvald
force-pushed
the
docs-toc-update
branch
from
d323391 to
2788b8c
Compare
edvald
force-pushed
the
docs-toc-update
branch
from
2788b8c to
2f9e0d0
Compare
What this PR does / why we need it:
This makes the table of contents in our docs site more readable (and attractive), and certain documentation sections more prominent.