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

[v16] Simplify how-to guides #47665

Merged
merged 1 commit into from
Oct 21, 2024
Merged

Conversation

ptgott
Copy link
Contributor

@ptgott ptgott commented Oct 17, 2024

Backport #47586 to branch/v16

Closes #38931

Remove "Static" and "Dynamic" configuration branching. Use the dynamic
approach unless the guide already shows readers how to use the static
approach elsewhere, e.g., using `teleport db configure create`.

For example, in the AWS OpenSearch guide, creating a Teleport
configuration is required for the guide anyway, so this change uses only
the static approach.

Ignore edge cases where the branching has some qualities that are unique
to a specific guide:

- `application-access/cloud-apis/google-cloud.mdx`: includes branching
  on authentication preference type.
- `application-access/guides/connecting-apps.mdx` because it explains
  syntax differences between the static and dynamic approaches.
- `enroll-aws-databases/aws-cross-account.mdx`: branches using three
  tabs, so editing requires another approach than the one this change
  applies.

This change edits only how-to guides, not conceptual guides, since the
goal of a how-to guide is to get the user to an end state as quickly as
possible.
@ptgott ptgott added the no-changelog Indicates that a PR does not require a changelog entry label Oct 17, 2024
@github-actions github-actions bot requested review from mmcallister and zmb3 October 17, 2024 14:55
Copy link

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

@ptgott ptgott added this pull request to the merge queue Oct 21, 2024
Merged via the queue into branch/v16 with commit 57e7847 Oct 21, 2024
42 of 43 checks passed
@ptgott ptgott deleted the bot/backport-47586-branch/v16 branch October 21, 2024 17:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport documentation no-changelog Indicates that a PR does not require a changelog entry size/sm
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants