Remove static/dynamic config branching in agent how-to guides #38931
Assignees
Labels
Comments
|
Here are the pages that include the relevant partials (there's one partial in this list, and it's shared between two guides): |
ptgott
added a commit
that referenced
this issue
Oct 15, 2024
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
added a commit
that referenced
this issue
Oct 17, 2024
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
added a commit
that referenced
this issue
Oct 17, 2024
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.
github-merge-queue bot
pushed a commit
that referenced
this issue
Oct 17, 2024
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.
github-actions bot
pushed a commit
that referenced
this issue
Oct 17, 2024
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Applies To
Multiple pages. See "Details".
Details
Some how-to guides for setting up Teleport agents include tab items that show users how to perform the same task with both dynamic resources and static agent configs. How-to guides should only provide guidance on a specific procedure, not all possible variations of the procedure, since otherwise a how-to guide can get to complex for users to follow.
For agent-related guides, we should show either configuration using dynamic resources or a static config file, then use the "Next steps" section to indicate that you can do both. We can also modify the Prerequisites sections of these guides to indicate that thes guide will show one several ways of doing things.
Here are guides/partials that include "static" and "dynamic" within a
Tabscomponent:How will we know this is resolved?
The
findcommand above returns no relevant output, with the pages shown above edited to include only one configuration example.Related Issues
The text was updated successfully, but these errors were encountered: