Skip to content

Add an overview of the Teleport documentation#34476

Merged
ptgott merged 2 commits intomasterfrom
paul.gottschling/34038-ov
Jan 25, 2024
Merged

Add an overview of the Teleport documentation#34476
ptgott merged 2 commits intomasterfrom
paul.gottschling/34038-ov

Conversation

@ptgott
Copy link
Copy Markdown
Contributor

@ptgott ptgott commented Nov 10, 2023

Closes #34038

Help visitors to the Teleport documentation find their way through the docs site by including a description of each docs page in an overview guide.

This change is based on adapting the former Teleport index page (prior to #27703).

@ptgott
Copy link
Copy Markdown
Contributor Author

ptgott commented Nov 10, 2023

Per a request from @stevenGravy

@ptgott ptgott requested a review from stevenGravy November 10, 2023 21:22
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Nov 10, 2023

The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with changelog: followed by the changelog entries for the PR.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Nov 10, 2023

🤖 Vercel preview here: https://docs-7hehytwha-goteleport.vercel.app/docs/ver/preview

@stevenGravy stevenGravy added the no-changelog Indicates that a PR does not require a changelog entry label Nov 10, 2023
@ptgott ptgott force-pushed the paul.gottschling/34038-ov branch from 921c4d0 to 276fee0 Compare November 13, 2023 22:54
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Nov 13, 2023

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

@zmb3
Copy link
Copy Markdown
Collaborator

zmb3 commented Nov 14, 2023

Are we still moving to a new docs engine this quarter? If so, will this go out of date as soon as we do that?

@ptgott
Copy link
Copy Markdown
Contributor Author

ptgott commented Nov 14, 2023

Are we still moving to a new docs engine this quarter? If so, will this go out of date as soon as we do that?

We don't have any plans to change the structure of the docs/pages directory tree alongside the migration, so the only thing that might change is how we organize the versions of the docs site. So far, it looks like we'll still use a dropdown menu for switching between versions. Otherwise, we could change the second paragraph.

@stevenGravy Since you made the request, I'd be interested to know how urgent this is—should we wait until the end of the quarter to check whether the migration will require us to fundamentally edit this page, or would it be valuable to have this overview for the next couple of months?

@ptgott ptgott force-pushed the paul.gottschling/34038-ov branch from 276fee0 to de0e2de Compare November 15, 2023 20:51
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Nov 15, 2023

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

@stevenGravy
Copy link
Copy Markdown
Contributor

stevenGravy commented Nov 15, 2023

Are we still moving to a new docs engine this quarter? If so, will this go out of date as soon as we do that?

We don't have any plans to change the structure of the docs/pages directory tree alongside the migration, so the only thing that might change is how we organize the versions of the docs site. So far, it looks like we'll still use a dropdown menu for switching between versions. Otherwise, we could change the second paragraph.

@stevenGravy Since you made the request, I'd be interested to know how urgent this is—should we wait until the end of the quarter to check whether the migration will require us to fundamentally edit this page, or would it be valuable to have this overview for the next couple of months?

Yes, this will still be valuable. We often have new team operator members joining existing Teleport deployments and this helps to orient them on what the documentation provides.

@ptgott ptgott force-pushed the paul.gottschling/34038-ov branch from de0e2de to 89fb93f Compare November 16, 2023 15:53
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Nov 16, 2023

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

@ptgott ptgott force-pushed the paul.gottschling/34038-ov branch from 89fb93f to ca98581 Compare November 27, 2023 16:56
@ptgott
Copy link
Copy Markdown
Contributor Author

ptgott commented Nov 27, 2023

@stevenGravy Just following up to see if you have time to review this. Thanks!

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Nov 27, 2023

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

@ptgott ptgott force-pushed the paul.gottschling/34038-ov branch from ca98581 to f67ad81 Compare November 28, 2023 19:02
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Dec 18, 2023

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

@ptgott ptgott force-pushed the paul.gottschling/34038-ov branch from 38aa205 to 1898af5 Compare December 19, 2023 14:30
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Dec 19, 2023

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

@ptgott ptgott force-pushed the paul.gottschling/34038-ov branch from 1898af5 to 6674b11 Compare January 2, 2024 18:58
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jan 2, 2024

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

@ptgott ptgott force-pushed the paul.gottschling/34038-ov branch from 6674b11 to ad1e253 Compare January 22, 2024 19:39
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jan 22, 2024

🤖 Vercel preview here: https://docs-42b019936-goteleport.vercel.app/docs/ver/preview

stevenGravy
stevenGravy approved these changes Jan 22, 2024
View reviewed changes
Comment thread docs/pages/documentation-overview.mdx Outdated
Comment thread docs/pages/documentation-overview.mdx Outdated
zmb3
zmb3 approved these changes Jan 22, 2024
View reviewed changes
Comment thread docs/config.json Outdated
Copy link
Copy Markdown
Collaborator

@zmb3 zmb3 Jan 22, 2024

Choose a reason for hiding this comment

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

Should this be the default page that we show at goteleport.com/docs?

Copy link
Copy Markdown
Contributor Author

@ptgott ptgott Jan 24, 2024

Choose a reason for hiding this comment

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

The overview is based on what used to be the default page. We changed the landing page to the previous "Install Teleport on a Linux Server" guide after a recommendation from Ev.

Comment thread docs/pages/documentation-overview.mdx Outdated
Comment thread docs/pages/documentation-overview.mdx Outdated
Copy link
Copy Markdown
Collaborator

@zmb3 zmb3 Jan 22, 2024

Choose a reason for hiding this comment

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

Suggested change
Teleport is protocol aware and provides functionality that is unique to each
Teleport is protocol-aware and provides functionality that is unique to each

Copy link
Copy Markdown
Contributor Author

@ptgott ptgott Jan 24, 2024

Choose a reason for hiding this comment

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

It's pretty common in style guides to allow for excluding hyphens in compound modifiers that take place after nouns, e.g., https://www.grammarly.com/blog/hyphen/

ptgott added 2 commits January 24, 2024 17:42
@ptgott
Add an overview of the Teleport documentation
8ba2890 
Closes #34038

Help visitors to the Teleport documentation find their way through the
docs site by including a description of each docs page in an overview
guide.

This change is based on adapting the former Teleport index page (prior
to #27703).
@ptgott
Minor grammar and language tweaks
396b702
@ptgott ptgott force-pushed the paul.gottschling/34038-ov branch from ad1e253 to 396b702 Compare January 24, 2024 22:50
@ptgott
Copy link
Copy Markdown
Contributor Author

ptgott commented Jan 24, 2024

Going to hold off on merging for a bit until I address this comment.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jan 24, 2024

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

@ptgott ptgott enabled auto-merge January 25, 2024 18:36
@ptgott ptgott added this pull request to the merge queue Jan 25, 2024
@github-merge-queue github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Jan 25, 2024
@ptgott ptgott added this pull request to the merge queue Jan 25, 2024
Merged via the queue into master with commit d217b87 Jan 25, 2024
@ptgott ptgott deleted the paul.gottschling/34038-ov branch January 25, 2024 19:38
@public-teleport-github-review-bot
Copy link
Copy Markdown

public-teleport-github-review-bot Bot commented Jan 25, 2024

@ptgott See the table below for backport results.

Branch Result
branch/v14 Create PR
branch/v15 Create PR

This was referenced Jan 25, 2024
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@zmb3 zmb3 zmb3 approved these changes

@stevenGravy stevenGravy stevenGravy approved these changes

@r0mant r0mant Awaiting requested review from r0mant

@xinding33 xinding33 Awaiting requested review from xinding33

Assignees

No one assigned

Labels

documentation no-changelog Indicates that a PR does not require a changelog entry size/md

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add an overview of the docs site

3 participants

@ptgott @zmb3 @stevenGravy