Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Split the "Setup" section of the docs #13359

Closed
ptgott opened this issue Jun 9, 2022 · 1 comment
Closed

Split the "Setup" section of the docs #13359

ptgott opened this issue Jun 9, 2022 · 1 comment

Comments

@ptgott
Copy link
Contributor

ptgott commented Jun 9, 2022

Details

This is one task within the docs reorganization project tracked by #12787, which reorganizes the documentation according to a user's familiarity with Teleport. This means structuring the left navigation menu as a timeline, beginning with "Get Started."

In this task, I propose splitting the "Setup" section. "Setup" is a bit vague, and it's not really clear when in a user's time with Teleport they should use the guides in that section.

We can split the "Setup" section into two sections:

  • "Manage your Cluster": This will contain all current content except for the "Reference" subsection. If we reframe the navigation sidebar as a timeline, "Manage your Cluster" follows from "Getting Started", "Configure Access", and "Add Resources" (depending on how we reorganize our content related to specific protocols).

  • "Reference": "Managing your Cluster" includes recurring operations that follow a user's initial setup, so after this, navigation sidebar links can drop the timeline metaphor. Readers looking for a quick reference to a specific configuration value, CLI flag, etc., can use the nav bar to identify the reference section, and don't need to look for it in "Setup."

Category

  • Improve Existing
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant