Reorganize the "Home" section of the docs #13342
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Jun 9, 2022
ptgott
force-pushed
the
paul.gottschling/12787-getting-started-section
branch
3 times, most recently
from
07b52c7 to
714099a
Compare
|
w.r.t
I think we're actually planning to use the preview session more and provide more clear messaging about features that are in preview. Maybe it makes sense to keep this section. |
Fixes #13206 The organization of the "Home" section of the docs currently says little about its purpose, making it more difficult for new visitors to the docs to find content. I've proposed changing this to a "Get Started" section that includes content related to trying out Teleport and choosing an edition. (Re)move pages that are unrelated to getting started: - Rename the "Preview" section to "Releases" and move the Changelog there. The Preview section doesn't include preview content very often, and usually only includes the Upcoming Releases page. I think it makes sense to devote this section to releases. - Remove the Adopters page and redirect to the Teleport case studies page. The Adopters page receives close to no traffic and is infrequently updated, so keeping it risks giving users outdated information. - Remove the Production guide. Redirects currently make it impossible to navigate to this page. - Move the Digital Ocean guide to "/docs/setup/deployments", since other platform-specific deployment guides are also placed there. Organize content related to getting started with Teleport into "Try out Teleport" and "Deploy a Teleport Cluster" subsections: - Encourage new users to try a quick lab by including a new menu page with links to all of our Instruqt tracks and local demo environments. Move our demo environment guides into "getting-started/try-out-teleport" - Put all of our edition-specific Getting Started guides into one subsection, "getting-started/deploy-a-cluster". This means that the Linux Server guide is no longer the de facto entryway into Teleport, which can confuse Cloud and Enterprise users. The "Deploy a Cluster" subsection includes a menu page with a guide to different editions. - With these new subsections, there's not really a place anymore for the /getting-started.mdx page, so I have removed this.
Restore the "Preview" section and Changelog page, since the Preview section will be used for more preview content after all.
ptgott
force-pushed
the
paul.gottschling/12787-getting-started-section
branch
from
05d29a3 to
20c64a3
Compare
|
Converted to a draft since we will be revisiting the reorganization plan for the docs (see #12787). Keeping this open in case we can modify it to accommodate the new plan. |
|
Closing in favor of #15357 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #13206
The organization of the "Home" section of the docs currently says little
about its purpose, making it more difficult for new visitors to the docs
to find content. I've proposed changing this to a "Get Started" section
that includes content related to trying out Teleport and choosing an
edition.
(Re)move pages that are unrelated to getting started:
Rename the "Preview" section to "Releases" and move the Changelog
there. The Preview section doesn't include preview content very often,
and usually only includes the Upcoming Releases page. I think it makes
sense to devote this section to releases.
Remove the Adopters page and redirect to the Teleport case studies
page. The Adopters page receives close to no traffic and is
infrequently updated, so keeping it risks giving users outdated
information.
Remove the Production guide. Redirects currently make it impossible
to navigate to this page.
Move the Digital Ocean guide to "/docs/setup/deployments", since other
platform-specific deployment guides are also placed there.
Organize content related to getting started with Teleport into "Try out
Teleport" and "Deploy a Teleport Cluster" subsections:
Encourage new users to try a quick lab by including a new menu page
with links to all of our Instruqt tracks and local demo environments.
Move our demo environment guides into
"getting-started/try-out-teleport"
Put all of our edition-specific Getting Started guides into one
subsection, "getting-started/deploy-a-cluster". This means that
the Linux Server guide is no longer the de facto entryway into
Teleport, which can confuse Cloud and Enterprise users.
The "Deploy a Cluster" subsection includes a menu page with a guide
and comparison table for Teleport's editions.
With these new subsections, there's not really a place anymore for the
/getting-started.mdx page, so I have removed this.