Simplify the docs site navigation #44327
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
🤖 Vercel preview here: https://docs-oyn55o3ge-goteleport.vercel.app/docs/ver/preview |
github-actions
bot
requested review from
hugoShaka,
mmcallister,
r0mant,
ravicious,
xinding33 and
zmb3
|
The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with |
|
Reviewer note: I'll add redirects once we backport to v16 since links from Google, the Web UI, etc. point to the default version of the docs site. |
|
If you move the generated chart references you must also edit the generation commands in Once this is done, you might want to check the generation still work: make -C examples/chart check-chart-ref
make -C examples/chart render-chart-ref |
ptgott
force-pushed
the
paul.gottschling/2024-07-reorg-reference
branch
from
a83dd9b
to
130d93e
Compare
|
The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with |
|
🤖 Vercel preview here: https://docs-r3dua2qqm-goteleport.vercel.app/docs/ver/preview |
ptgott
force-pushed
the
paul.gottschling/2024-07-reorg-reference
branch
from
130d93e
to
208c27c
Compare
Thanks! Fixed in 208c27c66bc244df4a5664e402ecd1da593fabac |
|
The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with |
|
🤖 Vercel preview here: https://docs-3jlf3qekl-goteleport.vercel.app/docs/ver/preview |
ravicious
approved these changes
Jul 19, 2024
xinding33
approved these changes
Jul 19, 2024
ptgott
force-pushed
the
paul.gottschling/2024-07-reorg-reference
branch
from
208c27c
to
4aa2f04
Compare
ptgott
added a commit
that referenced
this pull request
Aug 6, 2024
Backports #44327 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.
ptgott
added a commit
that referenced
this pull request
Aug 6, 2024
Backports #44327 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.
ptgott
added a commit
that referenced
this pull request
Aug 6, 2024
Backports #44327 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.
github-merge-queue bot
pushed a commit
that referenced
this pull request
Aug 6, 2024
Backports #44327 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.
|
FYI, this broke the output of FYI @ptgott @hugoShaka. |
|
Fix: #45175 |
ptgott
added a commit
that referenced
this pull request
Aug 8, 2024
Backports #44327 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.
ptgott
added a commit
that referenced
this pull request
Aug 8, 2024
Backports #44327 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.
ptgott
added a commit
that referenced
this pull request
Aug 8, 2024
Backports #44327 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.
ptgott
added a commit
that referenced
this pull request
Aug 12, 2024
Backports #44327 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.
ptgott
added a commit
that referenced
this pull request
Aug 13, 2024
Backports #44327 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.
ptgott
added a commit
that referenced
this pull request
Aug 13, 2024
Backports #44327 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.
ptgott
added a commit
that referenced
this pull request
Aug 14, 2024
Backports #44327 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.
github-merge-queue bot
pushed a commit
that referenced
this pull request
Aug 14, 2024
* Simplify the docs site navigation Backports #44327 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. * Fix terraform provider reference index (#45175) * Reorganize Teleport Policy docs Backports #45229 The Teleport Policy docs are currently in two sections of `/admin-guides/access-controls` with overlapping subject areas. This change merges the two sections into a single subsection of `/admin-guides`. To preserve the convention of moving all self-hosted guides into `/admin-guides/deploy-a-cluster`, this change also moves guides to self-hosting the Access Graph Service into `/admin-guides/deploy-a-cluster/access-graph`. More specific changes: - Add a subsection of the Policy section for integrations. - Make the Policy section a top-level section within Admin Guides, since we add another directory, to keep the max sidebar depth at four. - Move the contents of `/admin-guides/access-controls/access-graph` to the `/admin-guides/teleport-policy/integrations` directory, since all of the guides in `access-graph` had to do with integrations. - Change the Teleport Policy Integrations page into a menu. The page overlaps with the instructions on the AWS integration, so repurpose the guide as an overview. - Turn the Policy Get Started guide into a menu. The guide is a brief overview, so it functions well as the introduction to a menu page. - Rename the usage guide so it appears first on the auto-generated sidebar section. --------- Co-authored-by: Hugo Shaka <[email protected]>
ptgott
added a commit
that referenced
this pull request
Aug 14, 2024
Backports #44327 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.
ptgott
added a commit
that referenced
this pull request
Aug 15, 2024
Backports #44327 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.
ptgott
added a commit
that referenced
this pull request
Aug 28, 2024
Backports #44327 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.
ptgott
added a commit
that referenced
this pull request
Aug 28, 2024
These links were updated to include incorrect targets during the reorganization work in #44327.
github-merge-queue bot
pushed a commit
that referenced
this pull request
Aug 29, 2024
These links were updated to include incorrect targets during the reorganization work in #44327.
github-actions bot
pushed a commit
that referenced
this pull request
Aug 29, 2024
These links were updated to include incorrect targets during the reorganization work in #44327.
github-merge-queue bot
pushed a commit
that referenced
this pull request
Aug 30, 2024
These links were updated to include incorrect targets during the reorganization work in #44327.
ptgott
added a commit
that referenced
this pull request
Aug 30, 2024
Backports #44327 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.
ptgott
added a commit
that referenced
this pull request
Sep 3, 2024
Backports #44327 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.
github-merge-queue bot
pushed a commit
that referenced
this pull request
Sep 3, 2024
* Simplify the docs site navigation Backports #44327 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. * Reorganize Teleport Policy docs Backports #45229 The Teleport Policy docs are currently in two sections of `/admin-guides/access-controls` with overlapping subject areas. This change merges the two sections into a single subsection of `/admin-guides`. To preserve the convention of moving all self-hosted guides into `/admin-guides/deploy-a-cluster`, this change also moves guides to self-hosting the Access Graph Service into `/admin-guides/deploy-a-cluster/access-graph`. More specific changes: - Add a subsection of the Policy section for integrations. - Make the Policy section a top-level section within Admin Guides, since we add another directory, to keep the max sidebar depth at four. - Move the contents of `/admin-guides/access-controls/access-graph` to the `/admin-guides/teleport-policy/integrations` directory, since all of the guides in `access-graph` had to do with integrations. - Change the Teleport Policy Integrations page into a menu. The page overlaps with the instructions on the AWS integration, so repurpose the guide as an overview. - Turn the Policy Get Started guide into a menu. The guide is a brief overview, so it functions well as the introduction to a menu page. - Rename the usage guide so it appears first on the auto-generated sidebar section.
This was referenced Oct 4, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #24120
Provide a less overwhelming documentation experience for users by condensing sidebar sections into five, organized loosely around different audiences of the documentation:
Related changes:
docs/pages/includesdirectory so we can generate the sidebar fromdocs/pages/reference.