mirror of
https://github.com/gravitational/teleport
synced 2024-10-20 17:23:22 +00:00
7e11b3ab58
* Skeleton out docs refactor (#31017) * Start outlining index pages * More reshuffling * Remove old guides index page * Adjust sidebar config * Fix redirect * Fix crosslinks * Fix changelog links * Fix more links * Add short descriptions for platform guides * Improve some page descriptions/signposting * Nicer title * Outline intro page * Add notes on common usecases * Remove old sections from introduction * Start to outline overview topics * Roughly expand on overview to cover bot user/bot role * Clarify usecases * Attempt to break up further reading section to be intelligible * SPAG * Add TODOs * Machine ID Docs Refactor: Kubernetes Platform Guide + some AWS/GCP (#31796) * Add config files needed for Kubernetes deployment * Tidy examples under defined headers * Add namespace to specs * Add notes on join methods * Further details on Kubernetes joining * Document kubernetes rbac resources * Skeleton out GCP/Linux platform guides * Add necessary topics to the background for GCP and Linux * Try and rewrite the blank role mdx to be less rubbish I'm pulling my hair out over this lol * Add a todo so I can come back to this part of the description when i can use words * Further flesh out the background shape and intor shape for the platform guides * Add more steps to k8s guide * Fix links to k8s page * Explain `kubernetes` join method * Add documentation to the token yaml * Add reasoning for role * Document deployment manifest * Add notes on determining if the deployment is healthy. * Add token yaml for aws/gcp from my reference notes * Add token/bot creation step for aws,gcp,linux * customizing * Machine ID Docs Refactor: Add `tctl` and `terraform` access guides (#32036) * Outline `tctl` access doc * Flesh out Terraform page with an example * Fill out the copy for the Terraform provider guide * Add explanation to configure tbot step of Terraform guide * Add similar explanatory prose to tctl.mdx * Add example role for tctl guide * Try to better explain modifying the existing role * Fix prerequisites * Note on configuring permissions * Fix SPAG * Appease linter * Expand intro for Terraform * Please linter with newlines * Remove spurious newline * Clarify install/confgiure language * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/tctl.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update docs/pages/machine-id/access-guides/terraform.mdx Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Remove bactics from title * Make example roles less powerful * Add example of tctl command to check success * Correctly say platform guide not access guide * Be more specific in mentioning `tbot` --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Remove V11 support warnings from platform guides * Machine ID Docs Refactor: Linux VM based Platform Guides (#32472) * Add pre-requisites * Add example systemd service * Notes on oneshot mode * Offer daemon or oneshot mode docs * Hide one-shot mode from `token` join based Linux * Clarify Linux user for access * Use variables for the token and explain commands * Explain creating systemd service * Explain when to prefer one-shot mode * Add skeleton for Azure * Document azure join token fields * Add intros for guides * Explain why we protect the directory * Add install instructions * Remove step regarding writing token to a seperate file * Move coinfigure outputs to template * Signify each step as local machine or target host * Explain gcp/azure join methods * Explain token and iam join methods * Remove no longer recommended host certs guide * Add next step * Correct list of supported join methods * Machine ID Docs Refactor: Rewrite GitLab and CircleCI guides (#32834) * Start reshaping the circleic guide * Make some changes to the GitLab side as well * Add role creation to GitLab guide * Add role creation step to CircleCI guide * Adjust token file name * Make sure anonymous telemetry advice is included * Machine ID Docs Refactor: GitHub Actions docs (#32854) * Start restructuring GHA guides * Copy in Kubernetes Action example * Add example DIY workflow * Adjust examples with replacement steps * Link off to the action github pages * Tidy up introduction for GHA guide * Explain GHA examples better and more searchably * Improved title * Add example role modifications * Machine ID Docs Refactor: Ansible Access Guide (#32741) * Rework Ansible with Server Access guide * SPAG and consistency suggested changes Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify intro and use the variable throughout * suggested fixes Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify configuring bot rbac --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Application Access (#32745) * Rework Application Access docs * Code review suggestions Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify RBAC --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: SSH Access guide (#32735) * Add prereqs for ssh access guide * Outline steps and output config * Add guidance on tsha nd OpenSSH * Guidance on other tools * Simplify guidance on other tools * Link to ansible guide * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Reorganise RBAC section * Fix miscopied sentence --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Architecture and Introduction (#32901) * Rewrite getting started guide next steps * Rewrite introduction introduction to focus on tangible machine ID benefits * Overview * Add todo markers * Rewrite overview * Rewrite some of the architecture page * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Rearrange "overview" to act as "concepts" --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Database Access (#32743) * Rewrite database access guide * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Clarify that systemd should be used rather than exercise for reader --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Machine ID Docs Refactor: Kubernetes Access (#32744) * Rewrite Kubernetes access guide * Code review suggestions Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Explain need for kubectl on both client machine and machine id host * spag * Fix `kubernetes_resources` example * Further clarify `kubernetes_resources` --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Edit the Machine ID docs refactor (#33596) * Edit the Machine ID docs refactor - **Rename the new guides:** Use the "Connect a Bot" and "Deploy Machine ID" language instead of "Access Guides" and "Platform Guides" to connect these guides more explicitly to the language we use in the "Concepts" discussion of the Machine ID landing page. - **Add context to the deployment guide index page**: Reduce repetition and provide information about each deployment method to help users get more context about how Machine ID runs and joins a cluster, as well as to help users choose a deployment guide. - **Make links more visible on the Machine ID intro page:** Use a video banner for the Machine ID intro so it takes up less space on the page. Shorten some sections and add more specific H2s for the links. - **Streamline some deployment guides:** Where guides include "Background" and "Guide" H2s, blend the introductory information with the guide so we can promote the "Step" H2s to H3s and direct the reader to the step-by-step instructions more quickly. - **Add new pages to the docs table of contents.** * Respond to zmb3 feedback - List cloud platforms before CI/CD platforms on the sidebar - Recommend using platform-signed identity documents in the deployment guide intro page. - Edit language introducing join tokens. * Respond to strideynet feedback - Edit wording in the deployment guide index page, including renaming a section heading and adding language re: renewable certs in the static token join method. - Change GitHub Actions link. - Rename the Access Guides back to "Access Guides" * Fix spelling * Appease linter --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> |
||
|---|---|---|
| .. | ||
| img | ||
| pages | ||
| config.json | ||
| cspell.json | ||
| postrelease.md | ||
| preflight.md | ||
| prerelease.md | ||
| README.md | ||
Teleport Docs
Teleport docs are built using Next.js. Please see the README in the docs repo for details on how to make and test changes to Teleport docs.
Linting and checking for bad links
Run make -C build.assets test-docs from the root directory of this repo.