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

Add docs for hardware keys in Connect #48453

Merged
merged 3 commits into from
Nov 7, 2024

Conversation

gzdunek
Copy link
Contributor

@gzdunek gzdunek commented Nov 5, 2024

The documentation isn't very extensive, but I wanted to avoid repeating information that we already have in https://goteleport.com/docs/admin-guides/access-controls/guides/hardware-key-support/

If you think we can add more here, I'm open to suggestions!

@gzdunek gzdunek added no-changelog Indicates that a PR does not require a changelog entry backport/branch/v16 labels Nov 5, 2024
@gzdunek gzdunek requested a review from ptgott November 5, 2024 17:28
Copy link

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-48453.d3pp5qlev8mo18.amplifyapp.com

Copy link

github-actions bot commented Nov 5, 2024

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

Copy link

github-actions bot commented Nov 7, 2024

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

@gzdunek gzdunek marked this pull request as ready for review November 7, 2024 15:28
@gzdunek gzdunek requested a review from ravicious November 7, 2024 15:28
@@ -216,6 +216,27 @@ The application connection tab shows an example command that can be used to quer
Requests sent under the displayed address will be proxied through an authenticated tunnel to the
application.

## Hardware key support
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd put it right before the Configuration section. It's an extra feature that Connect supports that requires specific hardware, so I think it should be below sections that are applicable to a bigger user group.

Configuration is more like a reference section and anything below is not feature-related, hence this ordering where Hardware key support would be just above Configuration.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense, done.

@gzdunek gzdunek enabled auto-merge November 7, 2024 15:51
@gzdunek gzdunek added this pull request to the merge queue Nov 7, 2024
Copy link

github-actions bot commented Nov 7, 2024

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

Merged via the queue into master with commit f0b8eef Nov 7, 2024
41 checks passed
@gzdunek gzdunek deleted the gzdunek/connect-hardware-key-docs branch November 7, 2024 16:13
@public-teleport-github-review-bot

@gzdunek See the table below for backport results.

Branch Result
branch/v16 Create PR
branch/v17 Create PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants