Hide navigation menu entries based on scope #11383

ptgott · 2022-03-23T14:54:07Z

Details

We recently added the ability to modify the navigation menu based on the value of the scope switcher (https://github.com/gravitational/next/pull/987). Let's do the following:

Put it into practice. For any guide that is entirely irrelevant for users of a particular scope, ensure that there is (a) an edition warning at the top of the page (using a scoped Notice component) and (b) a hideInScopes setting in config.json for that guide.
Document the hideInScopes configuration setting in our documentation contribution guidance

Category

Improve Existing

The text was updated successfully, but these errors were encountered:

While working on adjusting the visibility of docs nav bar entries based on scope (gravitational/teleport#11383), I realized that some nav bar sections are filled with irrelevant pages, but a user might want to read the introduction of that section. For example, the Enterprise section is irrelevant to OSS users, but these users may still be interested in learning more about Teleport Enterprise. One possibility would be to leave these section as-is for readers with an unintend scope. However, these readers would see edition warnings in the pages within a section unless they changed the value of the scope picker. As an alternative, we can hide scope-irrelevant content from the nav bar menu and section introduction pages, but include those pages, and add a prominent link that enables the reader to change scope. I've suggested the ScopeSwitchTile as a way of doing this. When a user clicks the ScopeSwitchTile, the current scope changes to a fixed value. We would use a ScopedBlock to hide menu items in section introduction pages from users with scopes that are not related to the section. We would then use a ScopeSwitchTile to enable the user to switch scopes and see the related content.

See #11383 Ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu. In some cases, e.g., the introduction pages for the Cloud, Getting Started, and Enterprise sections, the content is irrelevant to certain scopes but a reader still may want to find out more. One possibility would be to leave these section as-is for readers with an unintend scope. However, these readers would see edition warnings in the pages within a section unless they changed the value of the scope picker. As an alternative, I've suggested using the ScopeSwitchTile, introduced in a separate PR against gravitational/docs, as a way of doing this. When a user clicks the ScopeSwitchTile, the current scope changes to a caller-configured value.

While working on adjusting the visibility of docs nav bar entries based on scope (gravitational/teleport#11383), I realized that some nav bar sections are filled with irrelevant pages, but a user might want to read the introduction of that section. For example, the Enterprise section is irrelevant to OSS users, but these users may still be interested in learning more about Teleport Enterprise. One possibility would be to leave these section as-is for readers with an unintend scope. However, these readers would see edition warnings in the pages within a section unless they changed the value of the scope picker. As an alternative, we can hide scope-irrelevant content from the nav bar menu and section introduction pages, but include those pages, and add a prominent link that enables the reader to change scope. I've suggested the ScopeSwitchTile as a way of doing this. When a user clicks the ScopeSwitchTile, the current scope changes to a caller- configured value. We would use a ScopedBlock to hide menu items in section introduction pages from users with scopes that are not related to the section. We would then use a ScopeSwitchTile to enable the user to switch scopes and see the related content.

See #11383 Ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu. In some cases, e.g., the introduction pages for the Cloud, Getting Started, and Enterprise sections, the content is irrelevant to certain scopes but a reader still may want to find out more. One possibility would be to leave these section as-is for readers with an unintend scope. However, these readers would see edition warnings in the pages within a section unless they changed the value of the scope picker. As an alternative, I've suggested using the ScopeSwitchTile, introduced in a separate PR against gravitational/docs, as a way of doing this. When a user clicks the ScopeSwitchTile, the current scope changes to a caller-configured value.

Closes gravitational#35 Closes gravitational#33 See gravitational/teleport#11383 Previously, the Link component would always set the "scope" query parameter in its href to the current value of DocsContext.scope. I wanted to make it possible to link to other scopes, allowing readers who are interested in another edition of Teleport to read content intended for that edition. We could add explicit links to different scopes in, for example, warnings at the top of scope-irrelevant pages or in introduction pages to sections that are only helpful for a specific Teleport edition (e.g., the Enterprise section). This change edits useNormalizedHref to add a "scope" value to the href's query if the input href has a "scope" key and the value is a valid scope name ("oss", "cloud", or "enterprise").

Closes #11383 Note that this PR depends on merging a gravitational/docs PR: gravitational/docs#51 Ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu. In some cases, e.g., the introduction pages for the Cloud, Getting Started, and Enterprise sections, the content is irrelevant to certain scopes but a reader still may want to find out more. One possibility would be to leave these section as-is for readers with an unintend scope. However, these readers would see edition warnings in the pages within a section unless they changed the value of the scope picker. As an alternative, this change used ScopedBlock to display links to the relevant scope for users with a scope that is not intended for a given menu page. Also directs Enterprise visitors to the Getting Started menu page to the Enterprise Getting Started page with an "enterprise" scope. This fixes #10594. Finally, wherever we include a warning at the top of an edition-incompatible guide, I've added links to the scopes that are supported for that guide. This should make it easier for users to realize that they can adjust the scope to have the intended docs experience.

Closes gravitational#35 Closes gravitational#33 See gravitational/teleport#11383 Previously, the Link component would always set the "scope" query parameter in its href to the current value of DocsContext.scope. I wanted to make it possible to link to other scopes, allowing readers who are interested in another edition of Teleport to read content intended for that edition. We could add explicit links to different scopes in, for example, warnings at the top of scope-irrelevant pages or in introduction pages to sections that are only helpful for a specific Teleport edition (e.g., the Enterprise section). This change edits useNormalizedHref to add a "scope" value to the href's query if the input href has a "scope" key and the value is a valid scope name ("oss", "cloud", or "enterprise").

Closes #35 Closes #33 See gravitational/teleport#11383 Previously, the Link component would always set the "scope" query parameter in its href to the current value of DocsContext.scope. I wanted to make it possible to link to other scopes, allowing readers who are interested in another edition of Teleport to read content intended for that edition. We could add explicit links to different scopes in, for example, warnings at the top of scope-irrelevant pages or in introduction pages to sections that are only helpful for a specific Teleport edition (e.g., the Enterprise section). This change edits useNormalizedHref to add a "scope" value to the href's query if the input href has a "scope" key and the value is a valid scope name ("oss", "cloud", or "enterprise").

Closes #11383 Ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu. In some cases, e.g., the introduction pages for the Cloud, Getting Started, and Enterprise sections, the content is irrelevant to certain scopes but a reader still may want to find out more. One possibility would be to leave these section as-is for readers with an unintend scope. However, these readers would see edition warnings in the pages within a section unless they changed the value of the scope picker. As an alternative, this change used ScopedBlock to display links to the relevant scope for users with a scope that is not intended for a given menu page. Also directs Enterprise visitors to the Getting Started menu page to the Enterprise Getting Started page with an "enterprise" scope. This fixes #10594. Finally, wherever we include a warning at the top of an edition-incompatible guide, I've added links to the scopes that are supported for that guide. This should make it easier for users to realize that they can adjust the scope to have the intended docs experience.

See #11383 Ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu and menu pages. For pages that are only relevant to a specific scope, show users with unintended scopes a menu of links to supported scopes. This PR focuses on the Access Controls section.

See #11383 Help ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu and menu pages. For pages that aren't step-by-step guides and are meant to convey general information about a Teleport edition, show these pages in all scopes so users who are curious about another scope can get the information they need. This PR focuses on the Cloud section, and also fleshes out the introduction page to the Cloud section a bit.

See #11383 Ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu. In some cases, e.g., the introduction pages for the Cloud, Getting Started, and Enterprise sections, the content is irrelevant to certain scopes but a reader still may want to find out more. This change preserves purely informational content for all scopes, while including links to other scopes. This PR focuses on the Enterprise section.

* Hide Setup menu items based on scope Backports #12742 See #11383 Help ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu and menu pages. For pages that aren't step-by-step guides and are meant to convey general information about a Teleport edition, show these pages in all scopes so users who are curious about another scope can get the information they need. This PR focuses on the Setup section. * Hide Kube Access menu items based on scope Backports #12737 See #11383 Help ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu and menu pages. For pages that aren't step-by-step guides and are meant to convey general information about a Teleport edition, show these pages in all scopes so users who are curious about another scope can get the information they need. This PR focuses on the Kubernetes Access section. It also adds a short note at the top of the teleport-cluter Helm chart reference that the chart supports custom agent configurations along with the Auth/Proxy. * Hide Getting Started pages/links based on scope Backports #12718 See #11383 Help ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu and menu pages. For pages that aren't step-by-step guides and are meant to convey general information about a Teleport edition, show these pages in all scopes so users who are curious about another scope can get the information they need. This page focuses on the Getting Started section. Also reorganizes the getting-started.mdx menu page with the assumption that users of all editions will visit this page for some of their first guidance on using Teleport. With this change, getting-started.mdx now includes links to Getting Started guides in all editions, plus all of our local labs. - fixes #10594 - fixes #10199 * Hide Enterprise links/pages based on scope Backports #12716 See #11383 Ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu. In some cases, e.g., the introduction pages for the Cloud, Getting Started, and Enterprise sections, the content is irrelevant to certain scopes but a reader still may want to find out more. This change preserves purely informational content for all scopes, while including links to other scopes. This PR focuses on the Enterprise section. * Hide Cloud links/pages based on scope Backports #12712 * Hide Cloud links/pages based on scope See #11383 Help ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu and menu pages. For pages that aren't step-by-step guides and are meant to convey general information about a Teleport edition, show these pages in all scopes so users who are curious about another scope can get the information they need. This PR focuses on the Cloud section, and also fleshes out the introduction page to the Cloud section a bit. * Respond to PR feedback * Hide Access Controls links/pages based on scope Backports #12708 See #11383 Ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu and menu pages. For pages that are only relevant to a specific scope, show users with unintended scopes a menu of links to supported scopes. This PR focuses on the Access Controls section.

Backports #12737 See #11383 Help ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu and menu pages. For pages that aren't step-by-step guides and are meant to convey general information about a Teleport edition, show these pages in all scopes so users who are curious about another scope can get the information they need. This PR focuses on the Kubernetes Access section. It also adds a short note at the top of the teleport-cluter Helm chart reference that the chart supports custom agent configurations along with the Auth/Proxy.

Backports #12716 See #11383 Ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu. In some cases, e.g., the introduction pages for the Cloud, Getting Started, and Enterprise sections, the content is irrelevant to certain scopes but a reader still may want to find out more. This change preserves purely informational content for all scopes, while including links to other scopes. This PR focuses on the Enterprise section.

Backports #12737 See #11383 Help ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu and menu pages. For pages that aren't step-by-step guides and are meant to convey general information about a Teleport edition, show these pages in all scopes so users who are curious about another scope can get the information they need. This PR focuses on the Kubernetes Access section. It also adds a short note at the top of the teleport-cluter Helm chart reference that the chart supports custom agent configurations along with the Auth/Proxy.

Backports #12716 See #11383 Ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu. In some cases, e.g., the introduction pages for the Cloud, Getting Started, and Enterprise sections, the content is irrelevant to certain scopes but a reader still may want to find out more. This change preserves purely informational content for all scopes, while including links to other scopes. This PR focuses on the Enterprise section.

* Hide Kube Access menu items based on scope Backports #12737 See #11383 Help ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu and menu pages. For pages that aren't step-by-step guides and are meant to convey general information about a Teleport edition, show these pages in all scopes so users who are curious about another scope can get the information they need. This PR focuses on the Kubernetes Access section. It also adds a short note at the top of the teleport-cluter Helm chart reference that the chart supports custom agent configurations along with the Auth/Proxy. * Hide Enterprise links/pages based on scope Backports #12716 See #11383 Ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu. In some cases, e.g., the introduction pages for the Cloud, Getting Started, and Enterprise sections, the content is irrelevant to certain scopes but a reader still may want to find out more. This change preserves purely informational content for all scopes, while including links to other scopes. This PR focuses on the Enterprise section.

See #11383 Help ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu and menu pages. For pages that aren't step-by-step guides and are meant to convey general information about a Teleport edition, show these pages in all scopes so users who are curious about another scope can get the information they need. This PR focuses on the Setup section.

See #11383 Help ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu and menu pages. For pages that aren't step-by-step guides and are meant to convey general information about a Teleport edition, show these pages in all scopes so users who are curious about another scope can get the information they need. This PR focuses on the Server Access section. It also includes links to all Server Access guides in the intro page, since only the PAM guide was included before.

See #11383 Help ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu and menu pages. For pages that aren't step-by-step guides and are meant to convey general information about a Teleport edition, show these pages in all scopes so users who are curious about another scope can get the information they need. This page focuses on the Getting Started section. Also reorganizes the getting-started.mdx menu page with the assumption that users of all editions will visit this page for some of their first guidance on using Teleport. With this change, getting-started.mdx now includes links to Getting Started guides in all editions, plus all of our local labs. - fixes #10594 - fixes #10199

See #11383 Ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu and menu pages. For pages that are only relevant to a specific scope, show users with unintended scopes a menu of links to supported scopes. This PR focuses on the Access Controls section.

See #11383 Help ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu and menu pages. For pages that aren't step-by-step guides and are meant to convey general information about a Teleport edition, show these pages in all scopes so users who are curious about another scope can get the information they need. This PR focuses on the Cloud section.

* Hide Cloud links/pages based on scope See #11383 Help ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu and menu pages. For pages that aren't step-by-step guides and are meant to convey general information about a Teleport edition, show these pages in all scopes so users who are curious about another scope can get the information they need. This PR focuses on the Cloud section. * Respond to PR feedback

Backports #12742 See #11383 Help ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu and menu pages. For pages that aren't step-by-step guides and are meant to convey general information about a Teleport edition, show these pages in all scopes so users who are curious about another scope can get the information they need. This PR focuses on the Setup section.

Backports #12737 See #11383 Help ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu and menu pages. For pages that aren't step-by-step guides and are meant to convey general information about a Teleport edition, show these pages in all scopes so users who are curious about another scope can get the information they need. This PR focuses on the Kubernetes Access section. It also adds a short note at the top of the teleport-cluter Helm chart reference that the chart supports custom agent configurations along with the Auth/Proxy.

Backports #12718 See #11383 Help ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu and menu pages. For pages that aren't step-by-step guides and are meant to convey general information about a Teleport edition, show these pages in all scopes so users who are curious about another scope can get the information they need. This page focuses on the Getting Started section. Also reorganizes the getting-started.mdx menu page with the assumption that users of all editions will visit this page for some of their first guidance on using Teleport. With this change, getting-started.mdx now includes links to Getting Started guides in all editions, plus all of our local labs. - fixes #10594 - fixes #10199

Backports #12716 See #11383 Ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu. In some cases, e.g., the introduction pages for the Cloud, Getting Started, and Enterprise sections, the content is irrelevant to certain scopes but a reader still may want to find out more. This change preserves purely informational content for all scopes, while including links to other scopes. This PR focuses on the Enterprise section.

Backports #12712 * Hide Cloud links/pages based on scope See #11383 Help ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu and menu pages. For pages that aren't step-by-step guides and are meant to convey general information about a Teleport edition, show these pages in all scopes so users who are curious about another scope can get the information they need. This PR focuses on the Cloud section, and also fleshes out the introduction page to the Cloud section a bit. * Respond to PR feedback

Backports #12708 See #11383 Ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu and menu pages. For pages that are only relevant to a specific scope, show users with unintended scopes a menu of links to supported scopes. This PR focuses on the Access Controls section.

Backports #12742 See #11383 Help ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu and menu pages. For pages that aren't step-by-step guides and are meant to convey general information about a Teleport edition, show these pages in all scopes so users who are curious about another scope can get the information they need. This PR focuses on the Setup section.

Backports #12737 See #11383 Help ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu and menu pages. For pages that aren't step-by-step guides and are meant to convey general information about a Teleport edition, show these pages in all scopes so users who are curious about another scope can get the information they need. This PR focuses on the Kubernetes Access section. It also adds a short note at the top of the teleport-cluter Helm chart reference that the chart supports custom agent configurations along with the Auth/Proxy.

Backports #12718 See #11383 Help ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu and menu pages. For pages that aren't step-by-step guides and are meant to convey general information about a Teleport edition, show these pages in all scopes so users who are curious about another scope can get the information they need. This page focuses on the Getting Started section. Also reorganizes the getting-started.mdx menu page with the assumption that users of all editions will visit this page for some of their first guidance on using Teleport. With this change, getting-started.mdx now includes links to Getting Started guides in all editions, plus all of our local labs. - fixes #10594 - fixes #10199

Backports #12716 See #11383 Ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu. In some cases, e.g., the introduction pages for the Cloud, Getting Started, and Enterprise sections, the content is irrelevant to certain scopes but a reader still may want to find out more. This change preserves purely informational content for all scopes, while including links to other scopes. This PR focuses on the Enterprise section.

Backports #12712 * Hide Cloud links/pages based on scope See #11383 Help ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu and menu pages. For pages that aren't step-by-step guides and are meant to convey general information about a Teleport edition, show these pages in all scopes so users who are curious about another scope can get the information they need. This PR focuses on the Cloud section, and also fleshes out the introduction page to the Cloud section a bit. * Respond to PR feedback

Backports #12708 See #11383 Ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu and menu pages. For pages that are only relevant to a specific scope, show users with unintended scopes a menu of links to supported scopes. This PR focuses on the Access Controls section.

* Hide Setup menu items based on scope Backports #12742 See #11383 Help ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu and menu pages. For pages that aren't step-by-step guides and are meant to convey general information about a Teleport edition, show these pages in all scopes so users who are curious about another scope can get the information they need. This PR focuses on the Setup section. * Hide Kube Access menu items based on scope Backports #12737 See #11383 Help ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu and menu pages. For pages that aren't step-by-step guides and are meant to convey general information about a Teleport edition, show these pages in all scopes so users who are curious about another scope can get the information they need. This PR focuses on the Kubernetes Access section. It also adds a short note at the top of the teleport-cluter Helm chart reference that the chart supports custom agent configurations along with the Auth/Proxy. * Hide Getting Started pages/links based on scope Backports #12718 See #11383 Help ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu and menu pages. For pages that aren't step-by-step guides and are meant to convey general information about a Teleport edition, show these pages in all scopes so users who are curious about another scope can get the information they need. This page focuses on the Getting Started section. Also reorganizes the getting-started.mdx menu page with the assumption that users of all editions will visit this page for some of their first guidance on using Teleport. With this change, getting-started.mdx now includes links to Getting Started guides in all editions, plus all of our local labs. - fixes #10594 - fixes #10199 * Hide Enterprise links/pages based on scope Backports #12716 See #11383 Ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu. In some cases, e.g., the introduction pages for the Cloud, Getting Started, and Enterprise sections, the content is irrelevant to certain scopes but a reader still may want to find out more. This change preserves purely informational content for all scopes, while including links to other scopes. This PR focuses on the Enterprise section. * Hide Cloud links/pages based on scope Backports #12712 * Hide Cloud links/pages based on scope See #11383 Help ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu and menu pages. For pages that aren't step-by-step guides and are meant to convey general information about a Teleport edition, show these pages in all scopes so users who are curious about another scope can get the information they need. This PR focuses on the Cloud section, and also fleshes out the introduction page to the Cloud section a bit. * Respond to PR feedback * Hide Access Controls links/pages based on scope Backports #12708 See #11383 Ensure that no visitor to the Teleport docs site sees content that is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by hiding scope-irrelevant content from the navigation menu and menu pages. For pages that are only relevant to a specific scope, show users with unintended scopes a menu of links to supported scopes. This PR focuses on the Access Controls section.

ptgott added documentation cloud-docs labels Mar 23, 2022

ptgott added this to the Docs Sprint: March 28, 2022 - April 8, 2022 milestone Mar 23, 2022

ptgott mentioned this issue Apr 6, 2022

Hide navigation menu items based on scope #11784

Closed

ptgott mentioned this issue Apr 6, 2022

Add ScopeSwitchTile gravitational/docs#33

Closed

ptgott mentioned this issue Apr 22, 2022

Develop a more opinionated information architecture #12187

Closed

ptgott mentioned this issue May 9, 2022

Allow link hrefs with a scope query param gravitational/docs#51

Merged

ptgott modified the milestones: Docs Sprint: March 28, 2022 - April 8, 2022, Docs sprint: May 9, 2022 – May 20, 2022 May 16, 2022

ptgott mentioned this issue May 17, 2022

Hide Access Controls links/pages based on scope #12708

Merged

ptgott mentioned this issue May 17, 2022

Hide Cloud links/pages based on scope #12712

Merged

ptgott mentioned this issue May 17, 2022

Hide Enterprise links/pages based on scope #12716

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Hide navigation menu entries based on scope #11383

Hide navigation menu entries based on scope #11383

ptgott commented Mar 23, 2022

Hide navigation menu entries based on scope #11383

Hide navigation menu entries based on scope #11383

Comments

ptgott commented Mar 23, 2022

Details

Category