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

Update public docs for device trust web #41334

Merged
merged 8 commits into from
May 9, 2024

Conversation

codingllama
Copy link
Contributor

Update Device Trust pages in preparation for device trust web:

  • Remove notices that say the Web UI isn't supported
  • Mention Connect as a prereq
  • Update the App Access section (Web UI access is now possible)
  • Add a Desktop Access section (role-based enforcement is now possible)
  • Add/update troubleshooting

https://github.com/gravitational/teleport.e/issues/3236

@codingllama codingllama added the no-changelog Indicates that a PR does not require a changelog entry label May 8, 2024
@codingllama codingllama requested a review from avatus May 8, 2024 19:21
@codingllama
Copy link
Contributor Author

Separate commits for easier reviewing, although this ended up being quite small. I'm running the docs dev server locally, so it should render into something sensible.

I was torn about having a section that shows the web login, but decided against it as (I would hope!) it's easy and intuitive enough to get working. Plus, I didn't want to capture a screenshot that could quickly get outdated.

Copy link

github-actions bot commented May 8, 2024

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

Copy link

github-actions bot commented May 8, 2024

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

Desktop access may enforce device trust via [role-based enforcement](
#role-based-trusted-device-enforcement).

To access desktops protected by device trust make sure your device is
Copy link
Contributor

Choose a reason for hiding this comment

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

Are we capitalizing "device trust"? I would use consistent capitalization so readers know whether to treat this is as a Teleport-specific feature—if it's a general computing term that's not unique to Teleport, it would make sense to use lowercase everywhere.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll take a look and see what we are doing. Do you have a preference for capitalized or not in this particular case?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry for the delay. It's a mixed bag for sure, we use both capitalized and not in various places. If you have a suggestion, @ptgott, I'd be happy to write a follow-up "normalizing" it.

Copy link
Contributor

Choose a reason for hiding this comment

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

The AWS Verified Access docs say "device trust", although Okta capitalizes "Device Trust". I think this is a general enough computing term that "device trust" makes sense, though to be honest I can see "Device Trust" making sense as well. I'll ask Marketing and write a Vale rule for it so we can decouple the standardization work from this PR!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sounds great, thanks!

@codingllama codingllama enabled auto-merge May 9, 2024 15:20
@codingllama codingllama added this pull request to the merge queue May 9, 2024
Copy link

github-actions bot commented May 9, 2024

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

Merged via the queue into master with commit bf16543 May 9, 2024
37 of 38 checks passed
@codingllama codingllama deleted the codingllama/dtw-public-docs branch May 9, 2024 15:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation no-changelog Indicates that a PR does not require a changelog entry size/sm
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants