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

Propose a way to better organize agent service guides in the docs #13362

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

Propose a way to better organize agent service guides in the docs #13362

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."

Adding resources is part of getting started with Teleport, so if we are using the chronological organization of the navigation sidebar, it would make sense to add these guides to the "Getting Started" section. However, we have a lot of content in these guides, so moving all of them into a subsection of "Getting Started" could make the sidebar much harder to use.

For example, resource-specific sections have their own subsections, and our sidebar can support up to two levels of subsection headings. If we need to bump each subsection down a level, we will need to drop subsection headings from the sidebar.

After we complete the other tasks in #12787, we should come up with a clearer way to organize our docs on resource-specific services (e.g., the Database Service, Application Service, Machine ID, etc.).

Category

  • Improve Existing
@ptgott ptgott changed the title Propose a way to better organize resource service guides in the docs Propose a way to better organize agent service guides in the docs Aug 24, 2023
@ptgott
Copy link
Contributor Author

ptgott commented Dec 27, 2023

A year after opening this issue, we added a "Teleport Agents" section of the docs (commit on GitHub). This corrected one of the major deficiencies of the way we organize agent service docs: a way to provide information on all agent services, regardless of protocol.

I think this warrants closing the issue. If we have any more specific objectives/problems related to organizing the agent service guides, we can open a new issue with a new success condition.

@ptgott ptgott closed this as completed Dec 27, 2023
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