feature/docs v2 #297
Merged
feature/docs v2 #297
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
JohannesRudolph
commented
Aug 28, 2024
JohannesRudolph
commented
- feat: add experimental support for deploying foundation level modules
- feat: implement a simplified docs-v2 command
- refactor: remove unused DocumentationGenerator code
these have become a useful pattern to manage things that are consistent across your entire foundation like managing a common terraform state across multiple platforms, a central CI/CD pipeline for your IAC or generating docs (v2 coming soon...)
the v2 approach for generating docs using collie leverages terragrunt with a foundation-level terraform module that builds the documentation. This approach is more versatile and more performant - uses terraform_remote_state to quickly download documentation_md output from all platform modules, which is much faster than any other approach we tried before (see #271) - the terraform module can freely implement templating, ie symlinking the documentation site generator templates to enable docs hot reloading - users have better control to work natively with the documentation generator of their choice, because logic is moved out of collie-cli The terraform module that we will make available for now unfortunately no longer has support for generating kit module documentation. However we have found that there's little value in generating kit module documentation outside of the collie-hub use case, as most cloud foundation teams want to generate documentation for their application teams and are content with re-viewing terraform module documentation directly off the README.md files in git.
Move compliance control validation into KitDependencyAnalyzer. This ensures that controls are validated during "tree" commands. Before this change, only the "collie foundation docs" command validated that compliance statements reference actual controls.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.