[v18] Make the Terraform starter guide more visible#59435
Merged
ptgott merged 1 commit intobranch/v18from Sep 22, 2025
Merged
Conversation
Backports #59375 The Terraform starter guide, added in #44834, was meant to provide new Teleport users with a comprehensive example of deploying agents, configuring SSO, and managing RBAC. However, for a guide aimed at educating a broad audience, it gets very little exposure on the docs site. This change improves the visibility of the Terraform starter guide. - **Condense the two-part guide and its index page into a single guide:** Currently, the index page for the two-part guide has little substantial content and performs poorly in organic search. By condensing all content of the guide into a single page, we can provide a content-rich page that is more visible in search results. - **Move the guide:** Make it the Getting Started page within the `/docs/infrastructure-as-code/terraform-provider` section. This also clarifies the structure of the Infrastructure as Code section, since all Terraform-specific content is in a single subsection. To make this work, rename the sidebar titles of the Terraform section and add a link to the guide within the section index page. - **Minor edits to the Terraform starter guide:** Move the SSO guide links to the prerequisites section to avoid surprising the user with the need to context-switch. Remove an unneeded `tctl.mdx` partial inclusion. Remove prerequisite item re: following a Terraform setup guide, since this guide already shows the local demo method.
github-actions
Bot
added
backport
documentation
no-changelog
github-actions
Bot
requested review from
greedy52,
hugoShaka,
kimlisa,
mmcallister,
nklaassen,
r0mant,
stevenGravy and
zmb3
Contributor
|
Amplify deployment status
|
greedy52
approved these changes
Sep 22, 2025
hugoShaka
approved these changes
Sep 22, 2025
public-teleport-github-review-bot
Bot
removed request for
kimlisa,
mmcallister,
nklaassen,
r0mant,
stevenGravy and
zmb3
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Backports #59375
The Terraform starter guide, added in #44834, was meant to provide new Teleport users with a comprehensive example of deploying agents, configuring SSO, and managing RBAC. However, for a guide aimed at educating a broad audience, it gets very little exposure on the docs site. This change improves the visibility of the Terraform starter guide.
Condense the two-part guide and its index page into a single guide: Currently, the index page for the two-part guide has little substantial content and performs poorly in organic search. By condensing all content of the guide into a single page, we can provide a content-rich page that is more visible in search results.
Move the guide: Make it the Getting Started page within the
/docs/infrastructure-as-code/terraform-providersection. This also clarifies the structure of the Infrastructure as Code section, since all Terraform-specific content is in a single subsection. To make this work, rename the sidebar titles of the Terraform section and add a link to the guide within the section index page.Minor edits to the Terraform starter guide: Move the SSO guide links to the prerequisites section to avoid surprising the user with the need to context-switch. Remove an unneeded
tctl.mdxpartial inclusion. Remove prerequisite item re: following a Terraform setup guide, since this guide already shows the local demo method.