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

[v11] Remove Auth/Proxy instructions from DB guides #21685

Merged
merged 2 commits into from
Feb 13, 2023

Conversation

ptgott
Copy link
Contributor

@ptgott ptgott commented Feb 10, 2023

Backports #20308

  • Remove Auth/Proxy instructions from DB guides

Closes #11538

A number of our Database Service guides instruct the user to install the Auth Service and the Proxy Service. For users who have already set up these services, these instructions add friction. For users who have not set up these services, Teleport has existing instructions that users can follow instead.

This change edits our Database Access guides to require the user to have a running Teleport cluster as a prerequisite, in line with how-to guides in other sections of the docs.

Note that, while the issue this change closes is to add Auth/Proxy Service setup instructions to more places in the docs, this change follows our style guide recommendation (#20024) to add steps to the Prerequisites section if we have them documented elsewhere and they don't directly pertain to the goal of a how-to guide.

  • Respond to PR feedback

Change H3s to H2s


Co-authored-by: Alex Fornuto [email protected]

@ptgott
Copy link
Contributor Author

ptgott commented Feb 10, 2023

Note that this is a manual backport, so please handle with care!

@alexfornuto alexfornuto enabled auto-merge (squash) February 13, 2023 20:02
ptgott and others added 2 commits February 13, 2023 15:55
Backports #20308

* Remove Auth/Proxy instructions from DB guides

Closes #11538

A number of our Database Service guides instruct the user to install the
Auth Service and the Proxy Service. For users who have already set up
these services, these instructions add friction. For users who have
_not_ set up these services, Teleport has existing instructions that
users can follow instead.

This change edits our Database Access guides to require the user to have
a running Teleport cluster as a prerequisite, in line with how-to guides
in other sections of the docs.

Note that, while the issue this change closes is to add Auth/Proxy
Service setup instructions to _more_ places in the docs, this change
follows our style guide recommendation (#20024) to add steps to the
Prerequisites section if we have them documented elsewhere and they
don't directly pertain to the goal of a how-to guide.

* Respond to PR feedback

Change H3s to H2s

---------

Co-authored-by: Alex Fornuto <[email protected]>
@ptgott ptgott force-pushed the paul.gottschling/20308-bp-v11 branch from d80a985 to 07084ae Compare February 13, 2023 21:02
@alexfornuto alexfornuto merged commit 8e3efda into branch/v11 Feb 13, 2023
@alexfornuto alexfornuto deleted the paul.gottschling/20308-bp-v11 branch February 13, 2023 22:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants