Replace the `labels` frontmatter field with one called `tags`.
Docusaurus supports tag-based navigation out of the box with the `tags`
field. The original plan was to implement a separate system that allows
for filtering by multiple tags - which Docusaurus does not - but it
makes sense to enable the default approach as a first iteration.
* Add `product` and `type` tags to docs pages
We are rolling out standard `product` and `type` frontmatter fields for
each docs page, letting us use this metadata to perform operations on
pages that fall under a certain type or product. For example, we could
generate product-specific landing pages using the `product` field.
This change acts in tandem with gravitational/docs-website#249, which
lints the frontmatter of each docs page to enforce the `product` and
`type` fields.
Note that some guides have "Reference" in the title but are really more
like conceptual guides, providing information about how aspects of
Teleport work instead of a comprehensive reference of possible inputs.
Note that this change marks category index pages as having type `other`.
It might make sense to add a type for `index`, but this is something we
can modify when we need to perform operations on category index pages.
* Respond to roraback feedback
Instead of the `product:` and `type:` frontmatter fields, use a more
extensible approach, a single `labels` frontmatter field with a list of
string values.
* Respond to roraback feedback
Remove `other` items from the `labels` field.
Also add labels to new pages.
Provide a less overwhelming documentation experience for users by
condensing sidebar sections into five, organized loosely around
different audiences of the documentation:
- **Get Started:** new Teleport users, as well as users of all levels
who want to quickly look up key, frequently changing information, such
as the changelog and upcoming release information.
- **Admin Guides:** intermediate users completing a specific task. This
includes all how-to guides in the docs except those in "Get Started"
and "Enroll Resources".
- **Enroll Resources:** Admin Guides, but for our extensive library of
how-to guides for protecting infrastructure resources with Teleport.
- **References:** Advanced users looking for comprehensive reference
information and architecture guides. This includes all reference
guides in the docs.
- **User Guides:** Guides for end users looking to access resources.
Related changes:
- **Move Helm reference partials**. Use the `docs/pages/includes`
directory so we can generate the sidebar from `docs/pages/reference`.
- **Move the Architecture sidebar section** into "References", and move
architecture guides across the documentation into "Architecture".
- **Remove "Documentation Overview"** as this is out of date. Now, top-level
sidebar sections are more self explanatory.
- **Remove "Choose an Edition"**, since we want to elevate Teleport
Enterprise (Cloud), making Teleport Enterprise (Self-Hosted) available
for certain use cases.
- **Add an infrastructure as code section** to Admin Guides.
Paul Gottschling