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

[v14] Turn Architecture section intro into an overview #46563

Merged
merged 2 commits into from
Oct 4, 2024

Conversation

ptgott
Copy link
Contributor

@ptgott ptgott commented Sep 12, 2024

Backport #46457 to branch/v14

@ptgott ptgott added the no-changelog Indicates that a PR does not require a changelog entry label Sep 12, 2024
@ptgott ptgott force-pushed the bot/backport-46457-branch/v14 branch 3 times, most recently from 32689eb to 1690c12 Compare September 19, 2024 20:45
@ptgott ptgott force-pushed the bot/backport-46457-branch/v14 branch from 1690c12 to 3980466 Compare October 1, 2024 20:38
Closes #46015

While the Teleport docs do not include an architecture overview page,
there is a section intro for `docs/pages/reference/architecture` that
includes a table of contents. This change turns that page into an
architectural overview, providing context around each link to a child
architecture page.
- Tweak API wording.
- Remove the usage of "data plane".
- Correct item re: `tbot` join methods.
@ptgott ptgott force-pushed the bot/backport-46457-branch/v14 branch from 3980466 to 2e248cb Compare October 3, 2024 21:22
@ptgott
Copy link
Contributor Author

ptgott commented Oct 3, 2024

@mmcallister Would you have some time to review this backport? Thanks!

- [Proxy Peering](proxy-peering.mdx)

## Enrolling resources

Copy link
Contributor

Choose a reason for hiding this comment

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

This is a little out of scope, but it seems odd we don't have an overview of enrolling resources, like a general intro page here: https://goteleport.com/docs/enroll-resources

We have enrolling apps, k8s clusters, DBs etc but they're all rather distinct

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, that's a good point. I quickly crammed these all into the same section when reorganizing the docs to tidy up the sidebar, but didn't add an introduction to the section. I can open an issue

@public-teleport-github-review-bot public-teleport-github-review-bot bot removed the request for review from zmb3 October 3, 2024 23:02
@ptgott ptgott enabled auto-merge October 4, 2024 13:14
@ptgott ptgott added this pull request to the merge queue Oct 4, 2024
Merged via the queue into branch/v14 with commit ac293e7 Oct 4, 2024
27 checks passed
@ptgott ptgott deleted the bot/backport-46457-branch/v14 branch October 4, 2024 13:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 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