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

Prepare Kubernetes Access docs pages for the Cloud #10636

Closed
ptgott opened this issue Feb 25, 2022 · 1 comment
Closed

Prepare Kubernetes Access docs pages for the Cloud #10636

ptgott opened this issue Feb 25, 2022 · 1 comment

Comments

@ptgott
Copy link
Contributor

ptgott commented Feb 25, 2022

Details

As explained in #10631, we want to edit docs pages in high-priority sections to show only relevant information to users who have selected "Cloud" in the scope switcher. This issue focuses on the Kubernetes Access section.

Pages to edit

I generated a table of pages to edit by running the following script from the root of my gravitational/teleport repo clone:

$ echo "|Slug|PR|" && echo "|---|---|" && cat docs/config.json | jq '.navigation[] | select(.title=="Kubernetes Access").entries[] | recurse(.entries[]?) | .slug' | sed -E 's/(^.*$)/|\1||/'

Here is the output:

Slug PR
"/kubernetes-access/introduction/" #11154
"/kubernetes-access/getting-started/" N/A: We don't have a good method yet for adjusting the visibility of menu items within index pages depending on the user's scope.
"/kubernetes-access/getting-started/cluster/" N/A: Already includes an edition warning, which is all we can do until we can adjust the visibility of entire guides based on the scope selector.
"/kubernetes-access/getting-started/agent/" #11154
"/kubernetes-access/guides/" N/A: We don't have a good method yet for adjusting the visibility of menu items within index pages depending on the user's scope.
"/kubernetes-access/guides/multiple-clusters/" #11154
"/kubernetes-access/guides/cicd/" N/A: While this guide could use some reworking to match the format of our other guides (e.g., a Prerequisites section and numbered steps), the current instructions are relevant for users of all Teleport editions. Created an issue for reworking the guide: #11179
"/kubernetes-access/guides/federation/" #11154
"/kubernetes-access/guides/migration/" #11180
"/kubernetes-access/guides/standalone-teleport/" #11154
"/kubernetes-access/helm/guides/" N/A: We don't have a good method yet for adjusting the visibility of menu items within index pages depending on the user's scope.
"/kubernetes-access/helm/guides/aws/" #11177
"/kubernetes-access/helm/guides/gcp/" #11177
"/kubernetes-access/helm/guides/digitalocean/" #11177
"/kubernetes-access/helm/guides/custom/" #11177
"/kubernetes-access/helm/guides/migration/" #11177
"/kubernetes-access/helm/reference/" #11292
"/kubernetes-access/controls/" N/A: While this guide could use some reworking to match the format of our other guides (e.g., a Prerequisites section and numbered steps), the current instructions are relevant for users of all Teleport editions. Created an issue for reworking the guide: #11179

Category

  • Improve Existing
ptgott added a commit that referenced this issue Mar 15, 2022
See #10636

Introduction

- Remove unnecessary mention of Access Requests in a paragraph that is
  otherwise relevant for all editions.
- Minor style/grammar tweaks

Standalone Teleport

- Add tabbed instructions for different scopes where applicable.

- Minor style/grammar tweaks

Connect Kubernetes Cluster to Teleport

- Use Tabbed instructions and a Notice box so users with one scope
  do not see instructions for other scopes.

- Remove irrelevant details that are specific to self-hosted deployments.

Federation

- Add a Tabs component to separate instructions for Cloud and Self-
  Hosted users
- Minor style tweaks

Multiple Clusters

- Add tabbed instructions for Cloud/Self-Hosted users.
ptgott added a commit that referenced this issue Mar 16, 2022
While addressing #10636, I noticed that the Details box that appears
for Cloud users when they visit some of our Helm guides is in a slightly
odd location, in the middle of a Prerequisites item. I have moved this to
the top of each guide instead.

I have also refactored the helm-install.mdx partial to split it into
multiple partials, which allows us to use the "Step n/d" format in our
Helm guides.

Also adds a Cloud warning to the Digital Ocean Helm guide.
ptgott added a commit that referenced this issue Mar 16, 2022
See #10636

Introduction

- Remove unnecessary mention of Access Requests in a paragraph that is
  otherwise relevant for all editions.
- Minor style/grammar tweaks

Standalone Teleport

- Add tabbed instructions for different scopes where applicable.

- Minor style/grammar tweaks

Connect Kubernetes Cluster to Teleport

- Use Tabbed instructions and a Notice box so users with one scope
  do not see instructions for other scopes.

- Remove irrelevant details that are specific to self-hosted deployments.

Federation

- Add a Tabs component to separate instructions for Cloud and Self-
  Hosted users
- Minor style tweaks

Multiple Clusters

- Add tabbed instructions for Cloud/Self-Hosted users.
ptgott added a commit that referenced this issue Mar 18, 2022
While addressing #10636, I noticed that the Details box that appears
for Cloud users when they visit some of our Helm guides is in a slightly
odd location, in the middle of a Prerequisites item. I have moved this to
the top of each guide instead.

I have also refactored the helm-install.mdx partial to split it into
multiple partials, which allows us to use the "Step n/d" format in our
Helm guides.

Also adds a Cloud warning to the Digital Ocean Helm guide.
ptgott added a commit that referenced this issue Mar 18, 2022
While addressing #10636, I noticed that the Details box that appears
for Cloud users when they visit some of our Helm guides is in a slightly
odd location, in the middle of a Prerequisites item. I have moved this to
the top of each guide instead.

I have also refactored the helm-install.mdx partial to split it into
multiple partials, which allows us to use the "Step n/d" format in our
Helm guides.

Also adds a Cloud warning to the Digital Ocean Helm guide.
ptgott added a commit that referenced this issue Mar 21, 2022
This will make it easier to navigate to different values settings for
each chart, since values can have their own H2 sections that are
distinct from chart names. (Previously, both chart names and values
settings were organized into H2 section headings.)

This will also mean that edition warnings for Cloud users can be more
visible, since we can place them at the top of a page for a given chart.

See #10636
ptgott added a commit that referenced this issue Mar 21, 2022
This will make it easier to navigate to different values settings for
each chart, since values can have their own H2 sections that are
distinct from chart names. (Previously, both chart names and values
settings were organized into H2 section headings.)

This will also mean that edition warnings for Cloud users can be more
visible, since we can place them at the top of a page for a given chart.

See #10636
ptgott added a commit that referenced this issue Mar 21, 2022
Backports #11177

While addressing #10636, I noticed that the Details box that appears
for Cloud users when they visit some of our Helm guides is in a slightly
odd location, in the middle of a Prerequisites item. I have moved this to
the top of each guide instead.

I have also refactored the helm-install.mdx partial to split it into
multiple partials, which allows us to use the "Step n/d" format in our
Helm guides.

Also adds a Cloud warning to the Digital Ocean Helm guide.
ptgott added a commit that referenced this issue Mar 21, 2022
Backports #11177

While addressing #10636, I noticed that the Details box that appears
for Cloud users when they visit some of our Helm guides is in a slightly
odd location, in the middle of a Prerequisites item. I have moved this to
the top of each guide instead.

I have also refactored the helm-install.mdx partial to split it into
multiple partials, which allows us to use the "Step n/d" format in our
Helm guides.

Also adds a Cloud warning to the Digital Ocean Helm guide.
ptgott added a commit that referenced this issue Mar 21, 2022
Backports #11177

While addressing #10636, I noticed that the Details box that appears
for Cloud users when they visit some of our Helm guides is in a slightly
odd location, in the middle of a Prerequisites item. I have moved this to
the top of each guide instead.

I have also refactored the helm-install.mdx partial to split it into
multiple partials, which allows us to use the "Step n/d" format in our
Helm guides.

Also adds a Cloud warning to the Digital Ocean Helm guide.
ptgott added a commit that referenced this issue Mar 21, 2022
See #10636

Introduction

- Remove unnecessary mention of Access Requests in a paragraph that is
  otherwise relevant for all editions.
- Minor style/grammar tweaks

Standalone Teleport

- Add tabbed instructions for different scopes where applicable.

- Minor style/grammar tweaks

Connect Kubernetes Cluster to Teleport

- Use Tabbed instructions and a Notice box so users with one scope
  do not see instructions for other scopes.

- Remove irrelevant details that are specific to self-hosted deployments.

Federation

- Add a Tabs component to separate instructions for Cloud and Self-
  Hosted users
- Minor style tweaks

Multiple Clusters

- Add tabbed instructions for Cloud/Self-Hosted users.
ptgott added a commit that referenced this issue Mar 21, 2022
See #10636

Introduction

- Remove unnecessary mention of Access Requests in a paragraph that is
  otherwise relevant for all editions.
- Minor style/grammar tweaks

Standalone Teleport

- Add tabbed instructions for different scopes where applicable.

- Minor style/grammar tweaks

Connect Kubernetes Cluster to Teleport

- Use Tabbed instructions and a Notice box so users with one scope
  do not see instructions for other scopes.

- Remove irrelevant details that are specific to self-hosted deployments.

Federation

- Add a Tabs component to separate instructions for Cloud and Self-
  Hosted users
- Minor style tweaks

Multiple Clusters

- Add tabbed instructions for Cloud/Self-Hosted users.
ptgott added a commit that referenced this issue Mar 22, 2022
This will make it easier to navigate to different values settings for
each chart, since values can have their own H2 sections that are
distinct from chart names. (Previously, both chart names and values
settings were organized into H2 section headings.)

This will also mean that edition warnings for Cloud users can be more
visible, since we can place them at the top of a page for a given chart.

See #10636
ptgott added a commit that referenced this issue Mar 22, 2022
This will make it easier to navigate to different values settings for
each chart, since values can have their own H2 sections that are
distinct from chart names. (Previously, both chart names and values
settings were organized into H2 section headings.)

This will also mean that edition warnings for Cloud users can be more
visible, since we can place them at the top of a page for a given chart.

See #10636
ptgott added a commit that referenced this issue Mar 22, 2022
Backports #11177

While addressing #10636, I noticed that the Details box that appears
for Cloud users when they visit some of our Helm guides is in a slightly
odd location, in the middle of a Prerequisites item. I have moved this to
the top of each guide instead.

I have also refactored the helm-install.mdx partial to split it into
multiple partials, which allows us to use the "Step n/d" format in our
Helm guides.

Also adds a Cloud warning to the Digital Ocean Helm guide.
ptgott added a commit that referenced this issue Mar 22, 2022
Backports #11177

While addressing #10636, I noticed that the Details box that appears
for Cloud users when they visit some of our Helm guides is in a slightly
odd location, in the middle of a Prerequisites item. I have moved this to
the top of each guide instead.

I have also refactored the helm-install.mdx partial to split it into
multiple partials, which allows us to use the "Step n/d" format in our
Helm guides.

Also adds a Cloud warning to the Digital Ocean Helm guide.
ptgott added a commit that referenced this issue Mar 22, 2022
Backports #11177

While addressing #10636, I noticed that the Details box that appears
for Cloud users when they visit some of our Helm guides is in a slightly
odd location, in the middle of a Prerequisites item. I have moved this to
the top of each guide instead.

I have also refactored the helm-install.mdx partial to split it into
multiple partials, which allows us to use the "Step n/d" format in our
Helm guides.

Also adds a Cloud warning to the Digital Ocean Helm guide.
ptgott added a commit that referenced this issue Mar 22, 2022
Backports #11154

See #10636

Introduction

- Remove unnecessary mention of Access Requests in a paragraph that is
  otherwise relevant for all editions.
- Minor style/grammar tweaks

Standalone Teleport

- Add tabbed instructions for different scopes where applicable.

- Minor style/grammar tweaks

Connect Kubernetes Cluster to Teleport

- Use Tabbed instructions and a Notice box so users with one scope
  do not see instructions for other scopes.

- Remove irrelevant details that are specific to self-hosted deployments.

Federation

- Add a Tabs component to separate instructions for Cloud and Self-
  Hosted users
- Minor style tweaks

Multiple Clusters

- Add tabbed instructions for Cloud/Self-Hosted users.
ptgott added a commit that referenced this issue Mar 22, 2022
Backports #11154

See #10636

Introduction

- Remove unnecessary mention of Access Requests in a paragraph that is
  otherwise relevant for all editions.
- Minor style/grammar tweaks

Standalone Teleport

- Add tabbed instructions for different scopes where applicable.

- Minor style/grammar tweaks

Connect Kubernetes Cluster to Teleport

- Use Tabbed instructions and a Notice box so users with one scope
  do not see instructions for other scopes.

- Remove irrelevant details that are specific to self-hosted deployments.

Federation

- Add a Tabs component to separate instructions for Cloud and Self-
  Hosted users
- Minor style tweaks

Multiple Clusters

- Add tabbed instructions for Cloud/Self-Hosted users.
ptgott added a commit that referenced this issue Mar 22, 2022
Backports #11154

See #10636

Introduction

- Remove unnecessary mention of Access Requests in a paragraph that is
  otherwise relevant for all editions.
- Minor style/grammar tweaks

Standalone Teleport

- Add tabbed instructions for different scopes where applicable.

- Minor style/grammar tweaks

Connect Kubernetes Cluster to Teleport

- Use Tabbed instructions and a Notice box so users with one scope
  do not see instructions for other scopes.

- Remove irrelevant details that are specific to self-hosted deployments.

Federation

- Add a Tabs component to separate instructions for Cloud and Self-
  Hosted users
- Minor style tweaks

Multiple Clusters

- Add tabbed instructions for Cloud/Self-Hosted users.
ptgott added a commit that referenced this issue Mar 23, 2022
Backports #11154

See #10636

Introduction

- Remove unnecessary mention of Access Requests in a paragraph that is
  otherwise relevant for all editions.
- Minor style/grammar tweaks

Standalone Teleport

- Add tabbed instructions for different scopes where applicable.

- Minor style/grammar tweaks

Connect Kubernetes Cluster to Teleport

- Use Tabbed instructions and a Notice box so users with one scope
  do not see instructions for other scopes.

- Remove irrelevant details that are specific to self-hosted deployments.

Federation

- Add a Tabs component to separate instructions for Cloud and Self-
  Hosted users
- Minor style tweaks

Multiple Clusters

- Add tabbed instructions for Cloud/Self-Hosted users.
ptgott added a commit that referenced this issue Mar 23, 2022
Backports #11154

See #10636

Introduction

- Remove unnecessary mention of Access Requests in a paragraph that is
  otherwise relevant for all editions.
- Minor style/grammar tweaks

Standalone Teleport

- Add tabbed instructions for different scopes where applicable.

- Minor style/grammar tweaks

Connect Kubernetes Cluster to Teleport

- Use Tabbed instructions and a Notice box so users with one scope
  do not see instructions for other scopes.

- Remove irrelevant details that are specific to self-hosted deployments.

Federation

- Add a Tabs component to separate instructions for Cloud and Self-
  Hosted users
- Minor style tweaks

Multiple Clusters

- Add tabbed instructions for Cloud/Self-Hosted users.
ptgott added a commit that referenced this issue Mar 23, 2022
Backports #11154

See #10636

Introduction

- Remove unnecessary mention of Access Requests in a paragraph that is
  otherwise relevant for all editions.
- Minor style/grammar tweaks

Standalone Teleport

- Add tabbed instructions for different scopes where applicable.

- Minor style/grammar tweaks

Connect Kubernetes Cluster to Teleport

- Use Tabbed instructions and a Notice box so users with one scope
  do not see instructions for other scopes.

- Remove irrelevant details that are specific to self-hosted deployments.

Federation

- Add a Tabs component to separate instructions for Cloud and Self-
  Hosted users
- Minor style tweaks

Multiple Clusters

- Add tabbed instructions for Cloud/Self-Hosted users.
ptgott added a commit that referenced this issue Mar 23, 2022
Backports #11177

While addressing #10636, I noticed that the Details box that appears
for Cloud users when they visit some of our Helm guides is in a slightly
odd location, in the middle of a Prerequisites item. I have moved this to
the top of each guide instead.

I have also refactored the helm-install.mdx partial to split it into
multiple partials, which allows us to use the "Step n/d" format in our
Helm guides.

Also adds a Cloud warning to the Digital Ocean Helm guide.
ptgott added a commit that referenced this issue Mar 23, 2022
Backports #11154

See #10636

Introduction

- Remove unnecessary mention of Access Requests in a paragraph that is
  otherwise relevant for all editions.
- Minor style/grammar tweaks

Standalone Teleport

- Add tabbed instructions for different scopes where applicable.

- Minor style/grammar tweaks

Connect Kubernetes Cluster to Teleport

- Use Tabbed instructions and a Notice box so users with one scope
  do not see instructions for other scopes.

- Remove irrelevant details that are specific to self-hosted deployments.

Federation

- Add a Tabs component to separate instructions for Cloud and Self-
  Hosted users
- Minor style tweaks

Multiple Clusters

- Add tabbed instructions for Cloud/Self-Hosted users.
ptgott added a commit that referenced this issue Mar 23, 2022
Backports #11154

See #10636

Introduction

- Remove unnecessary mention of Access Requests in a paragraph that is
  otherwise relevant for all editions.
- Minor style/grammar tweaks

Standalone Teleport

- Add tabbed instructions for different scopes where applicable.

- Minor style/grammar tweaks

Connect Kubernetes Cluster to Teleport

- Use Tabbed instructions and a Notice box so users with one scope
  do not see instructions for other scopes.

- Remove irrelevant details that are specific to self-hosted deployments.

Federation

- Add a Tabs component to separate instructions for Cloud and Self-
  Hosted users
- Minor style tweaks

Multiple Clusters

- Add tabbed instructions for Cloud/Self-Hosted users.
ptgott added a commit that referenced this issue Mar 23, 2022
Backports #11177

While addressing #10636, I noticed that the Details box that appears
for Cloud users when they visit some of our Helm guides is in a slightly
odd location, in the middle of a Prerequisites item. I have moved this to
the top of each guide instead.

I have also refactored the helm-install.mdx partial to split it into
multiple partials, which allows us to use the "Step n/d" format in our
Helm guides.

Also adds a Cloud warning to the Digital Ocean Helm guide.
ptgott added a commit that referenced this issue Mar 23, 2022
Backports #11154

See #10636

Introduction

- Remove unnecessary mention of Access Requests in a paragraph that is
  otherwise relevant for all editions.
- Minor style/grammar tweaks

Standalone Teleport

- Add tabbed instructions for different scopes where applicable.

- Minor style/grammar tweaks

Connect Kubernetes Cluster to Teleport

- Use Tabbed instructions and a Notice box so users with one scope
  do not see instructions for other scopes.

- Remove irrelevant details that are specific to self-hosted deployments.

Federation

- Add a Tabs component to separate instructions for Cloud and Self-
  Hosted users
- Minor style tweaks

Multiple Clusters

- Add tabbed instructions for Cloud/Self-Hosted users.
ptgott added a commit that referenced this issue Mar 23, 2022
Backports #11177

While addressing #10636, I noticed that the Details box that appears
for Cloud users when they visit some of our Helm guides is in a slightly
odd location, in the middle of a Prerequisites item. I have moved this to
the top of each guide instead.

I have also refactored the helm-install.mdx partial to split it into
multiple partials, which allows us to use the "Step n/d" format in our
Helm guides.

Also adds a Cloud warning to the Digital Ocean Helm guide.
ptgott added a commit that referenced this issue Mar 23, 2022
Backports #11177

While addressing #10636, I noticed that the Details box that appears
for Cloud users when they visit some of our Helm guides is in a slightly
odd location, in the middle of a Prerequisites item. I have moved this to
the top of each guide instead.

I have also refactored the helm-install.mdx partial to split it into
multiple partials, which allows us to use the "Step n/d" format in our
Helm guides.

Also adds a Cloud warning to the Digital Ocean Helm guide.
ptgott added a commit that referenced this issue Mar 24, 2022
Backports #11292

This will make it easier to navigate to different values settings for
each chart, since values can have their own H2 sections that are
distinct from chart names. (Previously, both chart names and values
settings were organized into H2 section headings.)

This will also mean that edition warnings for Cloud users can be more
visible, since we can place them at the top of a page for a given chart.

See #10636
ptgott added a commit that referenced this issue Mar 24, 2022
Backports #11292

This will make it easier to navigate to different values settings for
each chart, since values can have their own H2 sections that are
distinct from chart names. (Previously, both chart names and values
settings were organized into H2 section headings.)

This will also mean that edition warnings for Cloud users can be more
visible, since we can place them at the top of a page for a given chart.

See #10636
ptgott added a commit that referenced this issue Mar 28, 2022
Backports #11292

This will make it easier to navigate to different values settings for
each chart, since values can have their own H2 sections that are
distinct from chart names. (Previously, both chart names and values
settings were organized into H2 section headings.)

This will also mean that edition warnings for Cloud users can be more
visible, since we can place them at the top of a page for a given chart.

See #10636
ptgott added a commit that referenced this issue Mar 28, 2022
Backports #11292

This will make it easier to navigate to different values settings for
each chart, since values can have their own H2 sections that are
distinct from chart names. (Previously, both chart names and values
settings were organized into H2 section headings.)

This will also mean that edition warnings for Cloud users can be more
visible, since we can place them at the top of a page for a given chart.

See #10636
ptgott added a commit that referenced this issue Mar 30, 2022
Backports #11292

This will make it easier to navigate to different values settings for
each chart, since values can have their own H2 sections that are
distinct from chart names. (Previously, both chart names and values
settings were organized into H2 section headings.)

This will also mean that edition warnings for Cloud users can be more
visible, since we can place them at the top of a page for a given chart.

See #10636
ptgott added a commit that referenced this issue Mar 30, 2022
Backports #11292

This will make it easier to navigate to different values settings for
each chart, since values can have their own H2 sections that are
distinct from chart names. (Previously, both chart names and values
settings were organized into H2 section headings.)

This will also mean that edition warnings for Cloud users can be more
visible, since we can place them at the top of a page for a given chart.

See #10636
ptgott added a commit that referenced this issue Mar 30, 2022
Backports #11292

This will make it easier to navigate to different values settings for
each chart, since values can have their own H2 sections that are
distinct from chart names. (Previously, both chart names and values
settings were organized into H2 section headings.)

This will also mean that edition warnings for Cloud users can be more
visible, since we can place them at the top of a page for a given chart.

See #10636
ptgott added a commit that referenced this issue Mar 31, 2022
Backports #11292

This will make it easier to navigate to different values settings for
each chart, since values can have their own H2 sections that are
distinct from chart names. (Previously, both chart names and values
settings were organized into H2 section headings.)

This will also mean that edition warnings for Cloud users can be more
visible, since we can place them at the top of a page for a given chart.

See #10636
ptgott added a commit that referenced this issue Mar 31, 2022
Backports #11292

This will make it easier to navigate to different values settings for
each chart, since values can have their own H2 sections that are
distinct from chart names. (Previously, both chart names and values
settings were organized into H2 section headings.)

This will also mean that edition warnings for Cloud users can be more
visible, since we can place them at the top of a page for a given chart.

See #10636
@ptgott
Copy link
Contributor Author

ptgott commented Apr 20, 2022

All linked PRs have been merged.

@ptgott ptgott closed this as completed Apr 20, 2022
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