Skip to content

Add Connect docs about linking tsh#19903

Merged
ravicious merged 6 commits into
masterfrom
ravicious/linking-tsh-docs
Jan 9, 2023
Merged

Add Connect docs about linking tsh#19903
ravicious merged 6 commits into
masterfrom
ravicious/linking-tsh-docs

Conversation

@ravicious
Copy link
Copy Markdown
Member

gravitational/webapps#1445 implemented RFD 99. tsh now is automatically added to PATH on Linux & Windows and macOS users can add it manually.

All we are missing is a section in the docs about it which is what this PR adds.

Comment thread docs/pages/connect-your-client/teleport-connect.mdx Outdated
Copy link
Copy Markdown
Contributor

@ptgott ptgott left a comment

Choose a reason for hiding this comment

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

Approved with minor suggestions. Along with Zac, I also think we should use "Teleport Connect" instead of "Connect"

Comment thread docs/pages/connect-your-client/teleport-connect.mdx Outdated
Comment thread docs/pages/connect-your-client/teleport-connect.mdx Outdated
@ravicious ravicious requested a review from zmb3 January 9, 2023 11:12
@ravicious ravicious force-pushed the ravicious/linking-tsh-docs branch from 58185a2 to 5b6ba92 Compare January 9, 2023 11:18
@ravicious
Copy link
Copy Markdown
Member Author

The last commit adds a note which explains that ultimately Connect and tsh use different TELEPORT_HOME so changes made in one app will not be reflected in the other. I figured it might not be obvious, in the near future we might change this anyway, but at the moment it'd be best to capture this in the docs.

@ravicious ravicious enabled auto-merge (squash) January 9, 2023 16:47
@ravicious ravicious merged commit 4859b04 into master Jan 9, 2023
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jan 9, 2023

@ravicious See the table below for backport results.

Branch Result
branch/v11 Create PR

@ravicious ravicious deleted the ravicious/linking-tsh-docs branch January 10, 2023 10:22
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