Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enforce a list of available editions in docs pages #39183

Closed
ptgott opened this issue Mar 11, 2024 · 1 comment
Closed

Enforce a list of available editions in docs pages #39183

ptgott opened this issue Mar 11, 2024 · 1 comment
Labels
documentation information-architecture Finding information in the docs

Comments

@ptgott
Copy link
Contributor

ptgott commented Mar 11, 2024

Applies To

Every page in the docs.

Details

We are migrating to a hosted documentation platform that does not support the "Available for" list below the page title banner in our current docs site:

image

We can indicate which editions a docs page applies to with a standard visual element at the top of each page, for example:

**Available for:** Teleport Enterprise Cloud, Teleport Enterprise

We can enforce the presence of an **Available for** list (and the editions named within the list) using Vale linters.

See the discussion in this PR for context: #38748

How will we know this is resolved?

  1. We have added an **Available for** list to each existing docs page. We can use the forScopes field in docs/config.json to automate this.
  2. We have added Vale style rules that require an **Available for** list at the top of each page.

Related Issues

@ptgott
Copy link
Contributor Author

ptgott commented Apr 16, 2024

Teleport now has a single commercial edition, "Enterprise", so this move no longer makes sense (see the screenshot from goteleport.com/pricing below). We have also removed the scope icons from the docs engine.

image

@ptgott ptgott closed this as not planned Won't fix, can't repro, duplicate, stale Apr 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation information-architecture Finding information in the docs
Projects
None yet
Development

No branches or pull requests

1 participant