search

gravitational / teleport

The easiest, and most secure way to access and protect all of your infrastructure.
https://goteleport.com
GNU Affero General Public License v3.0
17.69k stars 1.77k forks source link

Create a "Get Started" section of the docs #13206

Closed ptgott closed 2 years ago

ptgott commented 2 years ago

Details

As proposed in #12787, we would like to organize the docs site according to a user's familiarity with Teleport. The first step, "Get Started," will have its own section, which will replace the current "Home" section. This issue tracks the implementation of this reworked section.

Task Notes PR
Delete /docs/pages/production.mdx It is currently impossible to navigate to this page due to redirects. #13342
Move docs/pages/changelog.mdx I suggest changing the title of the "Preview" section to "Releases" and moving this page there. The only page in this section that is regularly updated is upcoming-releases.mdx [0], so it would make sense to reframe this section around releases. #13342
Move docs/pages/adopters.mdx Redirect to https://goteleport.com/case-study/ and remove this. This page gets little if any traffic, and only poses a risk of including outdated information #13342
Move docs/pages/getting-started/digitalocean.mdx Move this to the "Deployments" section, since we include other reference deployments for specific platforms there. #13342
Add a "Try out Teleport" subsection to the "Get Started" section Include the Docker Compose guide, local Kubernetes guide, and a menu page with links to all of our Instruqt tracks #13342
Add a "Choose an edition" subsection to "Get Started" Add an edition comparison page. Move the current Getting Started pages in the Cloud and Enterprise sections here, plus "Getting Started with a Linux Server." #13342
Keep the FAQ and Installation page in the "Get Started" section. Look into how to place these guides more naturally within the user's getting started experience #13342

Notes

[0]: Here are all the files changed by commits that affected the "Preview" section of the docs (this command was run from the root of gravitational/teleport on the current master branch):

  % git log --name-only --pretty="" -- docs/pages/preview | sort | uniq -c
   2 docs/pages/preview/releases-table.mdx
  12 docs/pages/preview/upcoming-releases.mdx

releases-table.mdx is no longer in the docs.

Category

ptgott commented 2 years ago

I'll probably be opening one PR to resolve this issue. The PR will incorporate the changes made in https://github.com/gravitational/teleport/pull/12923.

ptgott commented 2 years ago

This is finished.