-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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
[docs] GitHub proxy admin guide and tsh reference #50772
base: master
Are you sure you want to change the base?
Conversation
Amplify deployment status
|
ee2aee1
to
c99033f
Compare
f2b8d92
to
3f799da
Compare
@@ -0,0 +1,148 @@ | |||
--- | |||
title: GitHub Integration |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would make the title more descriptive about what the integration entails, e.g., "Manage GitHub Access with Teleport" (depending on what's accurate here).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not sure what's a good name here. i've changed it to Git Access with GitHub
as we don't manage access yet. we only proxying git commands. the manage access part will come at a later time for another feature.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For me, "Git Access with GitHub" implies that we're allowing users to access git using some feature of GitHub, which leaves out Teleport. Maybe "Proxy Git Commands with Teleport" would be descriptive enough for now?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ya, that's better. Though i do think we should include GitHub in the title since it's really a github integration. What What do you think about "Proxy Git Commands with Teleport for GitHub"? Is it too long?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that's good!
docs/pages/admin-guides/management/guides/github-integration.mdx
Outdated
Show resolved
Hide resolved
docs/pages/admin-guides/management/guides/github-integration.mdx
Outdated
Show resolved
Hide resolved
docs/pages/admin-guides/management/guides/github-integration.mdx
Outdated
Show resolved
Hide resolved
docs/pages/admin-guides/management/guides/github-integration.mdx
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I allowed myself to run the images through ImageOptim to reduce their size. I also added @2x
suffix to github-new-ca.png
so that the docs render it as a high DPI screenshot.
Well, changing the suffix didn't have any effect, as it seems that the new docs engine doesn't do anything with the prefix (cc @ptgott). Still, it's probably a good idea to have it anyway in case we decide to address high DPI screenshots. |
related:
note that the guide for the old method is removed: