Skip to content

Add docs for Connect My Computer#32798

Merged
ravicious merged 11 commits intomasterfrom
ravicious/cmc-docs
Oct 9, 2023
Merged

Add docs for Connect My Computer#32798
ravicious merged 11 commits intomasterfrom
ravicious/cmc-docs

Conversation

@ravicious
Copy link
Copy Markdown
Member

@ravicious ravicious commented Sep 29, 2023

RFD 133 describes how Connect My Computer works.

To try Connect My Computer yourself, you can download Connect v14.0.1, then from the three dots menu in the top right pick "Open config file", set "feature.connectMyComputer": true and restart the app. Now log in to a v14+ cluster and you should see the icon in the top left.

Connect 14.0.1 includes a bit outdated version of Connect My Computer, but it's mostly just small UI changes and bugfixes. Next week I'll make a fresh tag build and mention that here when it's done.

@ravicious ravicious temporarily deployed to vercel September 29, 2023 16:02 — with GitHub Actions Inactive
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Is this section big enough that it warrants having a separate page, perhaps written as a how-to guide?

I'm not sure about the how-to guide part, as there's not a lot of explaining what to do.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think this page is starting to burst at the seams a little bit, but we can leave the reorganization for a separate project!

@ravicious ravicious marked this pull request as ready for review September 29, 2023 16:04
@ravicious ravicious temporarily deployed to vercel September 29, 2023 16:10 — with GitHub Actions Inactive
@github-actions
Copy link
Copy Markdown
Contributor

🤖 Vercel preview here: https://docs-k52k1qc9y-goteleport.vercel.app/docs/ver/14.x

@github-actions
Copy link
Copy Markdown
Contributor

🤖 Vercel preview here: https://docs-a87wy482c-goteleport.vercel.app/docs/ver/14.x

@ravicious ravicious temporarily deployed to vercel October 2, 2023 08:29 — with GitHub Actions Inactive
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Oct 2, 2023

🤖 Vercel preview here: https://docs-50kqg39b6-goteleport.vercel.app/docs/ver/14.x

@ravicious ravicious temporarily deployed to vercel October 3, 2023 14:26 — with GitHub Actions Inactive
@ravicious ravicious temporarily deployed to vercel October 3, 2023 14:32 — with GitHub Actions Inactive
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Oct 3, 2023

🤖 Vercel preview here: https://docs-g9pun2or6-goteleport.vercel.app/docs/ver/14.x

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Oct 3, 2023

🤖 Vercel preview here: https://docs-18k29q14l-goteleport.vercel.app/docs/ver/14.x

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

Choose a reason for hiding this comment

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

I think this page is starting to burst at the seams a little bit, but we can leave the reorganization for a separate project!

Comment thread docs/pages/connect-your-client/teleport-connect.mdx
Next, the setup downloads a Teleport agent for your platform and runs `teleport node configure`
pointed at the current cluster. Once that is done, Connect My Computer starts the agent and waits
for it to show up in the cluster as an SSH node.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

A screenshot would be good here as well

Copy link
Copy Markdown
Member Author

@ravicious ravicious Oct 9, 2023

Choose a reason for hiding this comment

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

Added one extra screenshot for good measure. The first one shows where the Connect My Computer icon is compared to the rest of regular UI, the second one shows the setup and the third one shows the status view.

@ravicious ravicious enabled auto-merge October 9, 2023 14:36
@ravicious ravicious added this pull request to the merge queue Oct 9, 2023
@ravicious ravicious temporarily deployed to vercel October 9, 2023 14:42 — with GitHub Actions Inactive
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Oct 9, 2023

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

Merged via the queue into master with commit d21ae19 Oct 9, 2023
@ravicious ravicious deleted the ravicious/cmc-docs branch October 9, 2023 14:54
@public-teleport-github-review-bot
Copy link
Copy Markdown

@ravicious See the table below for backport results.

Branch Result
branch/v14 Create PR

github-merge-queue Bot pushed a commit that referenced this pull request Oct 10, 2023
* Reduce instances of "just"

* agent lifecycle -> the lifecycle of the agent

* proxy version -> Teleport Proxy Service version

* Simplify sentence about local user requirement

* Add screenshots of Connect My Computer

* Update screenshots of Connect UI
@ravicious ravicious mentioned this pull request Oct 16, 2023
8 tasks
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