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

Centralize our docs generators #52982

Open
ptgott opened this issue Mar 11, 2025 · 0 comments
Open

Centralize our docs generators #52982

ptgott opened this issue Mar 11, 2025 · 0 comments

Comments

@ptgott
Copy link
Contributor

ptgott commented Mar 11, 2025

Details

We maintain a number of scripts in gravitational/teleport for generating docs, including:

  • Terraform reference docs
  • Operator resource reference docs
  • Helm chart reference docs

...with others soon to be added. Let's come up with a clean, centralized way to either run or organize these so they're easier to maintain.

How will we know this is resolved?

We have implemented one or both of these solutions:

  1. Placed all generators in a single directory or GitHub repo (if we opt for the latter, we can pin a repo version to prevent generator changes from immediately breaking CI)
  2. Added a Make target that runs all docs generators, plus another target that checks if the current docs are up to date (i.e., for CI)

Related Issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant