Simplify how-to guides #47586
Merged
Simplify how-to guides #47586
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
github-actions
bot
requested review from
greedy52,
mmcallister,
nklaassen,
r0mant,
ravicious,
xinding33 and
zmb3
|
🤖 Vercel preview here: https://docs-d7va1isjm-goteleport.vercel.app/docs/ver/preview |
zmb3
approved these changes
Oct 16, 2024
mmcallister
approved these changes
Oct 17, 2024
public-teleport-github-review-bot
bot
removed request for
ravicious,
r0mant,
greedy52,
nklaassen and
xinding33
ptgott
added
the
no-changelog
ptgott
force-pushed
the
paul.gottschling/38931-branching
branch
from
0bac356 to
4bb9a43
Compare
|
🤖 Vercel preview here: https://docs-1qdnpgxbh-goteleport.vercel.app/docs/ver/preview |
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
force-pushed
the
paul.gottschling/38931-branching
branch
from
4bb9a43 to
5e294a4
Compare
|
🤖 Vercel preview here: https://docs-4nugj10kx-goteleport.vercel.app/docs/ver/preview |
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
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 #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.mdxbecause 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.