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

Abandoned documentation removal #1512

Open
zregvart opened this issue Apr 10, 2024 · 2 comments
Open

Abandoned documentation removal #1512

zregvart opened this issue Apr 10, 2024 · 2 comments

Comments

@zregvart
Copy link
Member

With the documentation generation in #1500 and #1493 the .adoc files are generated in docs/modules/ROOT/pages. A document created prior to it's abandonment, for example if a command or a Rego builtin is removed, will not be removed.
The document generation code should keep track of any abandoned components and remove the corresponding Asciidoc files.

@simonbaird
Copy link
Member

The lazy way would be to rm -rf all the generated files before regenerating them.

@zregvart
Copy link
Member Author

The lazy way would be to rm -rf all the generated files before regenerating them.

Yes, but we need a list of the ones we can remove, so fist step would be to figure out what .adoc files are generated vs which ones are handwritten. They're all in the same directory currently, so perhaps separating them somehow would be a good start.

The nav.adoc files get regenerated so we don't need to remove those.

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

No branches or pull requests

2 participants