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

Remove nested tabs from docs pages #47862

Merged
merged 2 commits into from
Oct 30, 2024
Merged

Remove nested tabs from docs pages #47862

merged 2 commits into from
Oct 30, 2024

Conversation

ptgott
Copy link
Contributor

@ptgott ptgott commented Oct 23, 2024

Closes #35870

Used the following command to find nested tabs:

$ find docs/pages -name "*.mdx" -exec awk '
/<TabItem/{ti=1}
ti==1 && /<\/TabItem/{ti=0}
ti==1 && /<Tabs/{n=1;if(lines=="") lines=FNR; else lines=(lines "," FNR)}
END{if(n>0) print FILENAME ":" lines}' {} \;

Edit the following guides:

  • Connect your Client intro: Remove branching between Community Edition and Teleport Enterprise. The only difference was the assumption that Community Edition users would only have a GitHub connector available. But if users must ask their administrator for an SSO connector name anyway, we don't need to specify the connector name here.
  • GUI clients: Use separate H4s to describe using a local proxy server and getting remote host information.
  • Self-Signed Certs: Don't use tabs to explain the difference in syntax between using --set and a values file in Helm. Instead, use inline prose.
  • Locking: Explain both the CAP and static config file in the "Self-Hosted" tab.
  • AWS Helm deployment: Remove the Community Edition tab in Step 5 and explain how to disable the enterprise field using a YAML comment
  • Kubernetes AWS auto-discovery: Collapse aws-auth and eks create-access-entry instructions into a single passage of text.

@hugoShaka
Copy link
Contributor

hugoShaka commented Oct 23, 2024

Where's the amplify bot when we need a preview? 😭

@ptgott
Copy link
Contributor Author

ptgott commented Oct 23, 2024

Where's the amplify bot when we need a preview? 😭

The Vercel build failed as well, so I'm guessing I messed up the syntax somewhere 🙃

Closes #35870

Used the following command to find nested tabs:

```
$ find docs/pages -name "*.mdx" -exec awk '
/<TabItem/{ti=1}
ti==1 && /<\/TabItem/{ti=0}
ti==1 && /<Tabs/{n=1;if(lines=="") lines=FNR; else lines=(lines "," FNR)}
END{if(n>0) print FILENAME ":" lines}' {} \;
```

Edit the following guides:

- **Connect your Client intro:** Remove branching between Community
  Edition and Teleport Enterprise. The only difference was the
  assumption that Community Edition users would only have a GitHub
  connector available. But if users must ask their administrator for an
  SSO connector name anyway, we don't need to specify the connector name
  here.
- **GUI clients:** Use separate H4s to describe using a local proxy
  server and getting remote host information.
- **Self-Signed Certs:** Don't use tabs to explain the difference in
  syntax between using `--set` and a values file in Helm. Instead, use
  inline prose.
- **Locking:** Explain both the CAP and static config file in the
  "Self-Hosted" tab.
- **AWS Helm deployment:** Remove the Community Edition tab in Step 5
  and explain how to disable the `enterprise` field using a YAML comment
- **Kubernetes AWS auto-discovery:** Collapse `aws-auth` and `eks
  create-access-entry` instructions into a single passage of text.
@ptgott ptgott force-pushed the paul.gottschling/35870-tabs branch from ab20ee6 to a97ea0e Compare October 28, 2024 18:50
Copy link

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-47862.d3pp5qlev8mo18.amplifyapp.com

Copy link

🤖 Vercel preview here: https://docs-p4o66ssgf-goteleport.vercel.app/docs/ver/preview

Copy link

🤖 Vercel preview here: https://docs-dx8wmroxh-goteleport.vercel.app/docs/ver/preview

@ptgott ptgott added this pull request to the merge queue Oct 30, 2024
Merged via the queue into master with commit caa2aac Oct 30, 2024
42 checks passed
@ptgott ptgott deleted the paul.gottschling/35870-tabs branch October 30, 2024 14:23
@public-teleport-github-review-bot

@ptgott See the table below for backport results.

Branch Result
branch/v16 Create PR
branch/v17 Create PR

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

Successfully merging this pull request may close these issues.

nested tabs in webauthn guide result in a poor UX
5 participants