Use Docusaurus syntax for admonitions so the docs engine does not need
to replace these. This is one step toward removing the
`remark-update-tags` plugin. See: gravitational/docs-website#94
Relevant commands are included below to make reproducing this work
easier.
1. Replace all `Notice` tags with `Admonition` tags.
2. Add `type="info"` if an Admonition is missing a type.
To find instances:
```
find docs/pages -name "*.mdx" -exec awk '
BEGIN{a=0}
a==0 && /<Admonition/{ a = 1 }
a==1 && /type/{t = 1}
a==1 && />/{ a = 0; if(t == 0) print FILENAME ":" FNR }' {} \;
```
3. Replace `type="notice"` with `type="note"`.
To find instances:
```
find docs/pages -name "*.mdx" -exec awk '
BEGIN{a=0}
a==0 && /<Admonition/{ a = 1 }
a==1 && /type="notice"/{t = 1}
a==1 && />/{ a = 0; if(t == 1) print FILENAME ":" FNR }' {} \;
```
* Edit apt-get installation instructions
Closes#24564
Show using `/etc/apt/trusted.gpg.d`, a directory that `apt-get` searches
automatically, for storing public keys. Edit the three locations where
we showed using `/usr/share/keyrings`, including two partials.
Trust only the Teleport-issued public key when validating Teleport DEB
packages.
* Use /etc/apt/keyrings for apt public keys
Respond to marcoandredinis feedback.
Closes#27252
Consolidate the `tctl-tsh-prerequisite.mdx` partial, which exists for
each Teleport edition. Edition-specific variations of this partial are
used in only 1-2 guides each, so consolidating these partials helps us
take advantage of reusability.
Closes#16433
- The Installation page is far more visible than the Teleport Cloud
Downloads page, so it makes sense to fold all of the information
related to installing Teleport binaries for managed Teleport
Enterprise users into the Installation page.
- We are moving away from including a "Choose an Edition" section that
treats Community Edition and the two Teleport Enterprise editions
as separate options. Instead, we want to encourage users to move from
OSS (personal use) to managed Enterprise and self-host in special
circumstances. As a result, it makes sense to include a single
Installation guide for all users.
Closes#40026
Reduce the space that our standard prerequisites partials take within
docs pages by:
- Using prose instead of tabs to suggest different possibilities for
getting started.
- Removing example commands to find the `tctl` and `tsh` versions. The
intended audience of the Teleport docs should be familiar enough with CLI
tools to infer that there is a `version` subcommand, as this is a
convention across CLI tools.
This change also removes `user-client-prereqs.mdx`, since it is no
longer used, and replaces `no-oss-prereq-tabs.mdx` with
`commercial-prereqs-tabs.mdx` (the two address the same use cases).
- Remove the `team` scope from config.json.
- Edit the Edition comparison table to remove the "Team" column.
- Change the Teleport Team getting started guide to a Teleport
Enterprise Cloud getting started guide.
- Remove other Teleport Team mentions from the docs.
* Remove non-file path links from partials
Fixes#12618
Ensure that all partials use relative links to MDX files for more
accurate linting. Only two partials contain links to URL paths, and one
of these is not included anywhere in the docs.
This change removes the unused partial and changes the remaining link to
a file path.
* Fix linter error
* Edit forScopes configurations and edit guides
Closes#26500
This change requires merging gravitational/docs#326 to add a Team scope
to the docs.
This updates pages within the docs so that:
- Each page's `forScopes` configuration is accurate, especially with
regard to support for Teleport Team.
- All scoped components match the `forScopes` configuration for each
page. For this, I used the linter introduced by
gravitational/docs#327.
* Respond to alexfornuto feedback
* docs: include Enterprise in tctl version for ent, cloud prereq
* rename includes for spell fix
* link fix
* move bullet points out of partials
---------
Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
In gravitational/docs#238, we will add a linter that lints for incorrect
usage of Teleport terms. This change fixes linter violations to
anticipate this new linter.
Changes include:
- Ensuring that Teleport service names are capitalized
- No longer using the "[Resource] Access" terminology. Instead, talk
about adding resources, using Teleport services, etc.
Fixes#14517
- Add a partial that briefly explains the value of Teleport Cloud for
use in guides that Teleport Cloud renders unnecessary. The partial
includes a signup link with the "source=docs" param so we can gauge
the effectiveness of these calls to action.
- Add the partial to guides for setting up and managing the Auth/Proxy
Services.
Paul Gottschling