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

[docs] GitHub proxy admin guide and tsh reference #50772

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

greedy52
Copy link
Contributor

@greedy52 greedy52 commented Jan 6, 2025

Copy link

github-actions bot commented Jan 6, 2025

Amplify deployment status

Branch Commit Job ID Status Preview Updated (UTC)
STeve/48762_docs c665e78 8 ✅SUCCEED steve-48762-docs 2025-01-10 15:21:02

@greedy52 greedy52 added the no-changelog Indicates that a PR does not require a changelog entry label Jan 6, 2025
@greedy52 greedy52 requested a review from ptgott January 7, 2025 14:24
@greedy52 greedy52 marked this pull request as ready for review January 7, 2025 14:24
@@ -0,0 +1,148 @@
---
title: GitHub Integration
Copy link
Contributor

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).

Copy link
Contributor Author

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.

Copy link
Contributor

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?

Copy link
Contributor Author

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?

Copy link
Contributor

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/includes/edition-prereqs-tabs-enterprise.mdx Outdated Show resolved Hide resolved
Copy link
Member

@ravicious ravicious left a 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.

@public-teleport-github-review-bot public-teleport-github-review-bot bot removed the request for review from xinding33 January 9, 2025 13:50
@ravicious
Copy link
Member

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.

@greedy52 greedy52 mentioned this pull request Jan 10, 2025
17 tasks
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/md
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants