docs: flesh out each of the component guides with some initial info#1816
Merged
Conversation
cardoe
force-pushed
the
component-docs
branch
2 times, most recently
from
188eac6 to
f278da7
Compare
skrobul
approved these changes
Mar 23, 2026
Collaborator
There was a problem hiding this comment.
This is technically accurate and I did not see any content specific issues, but I am hesitant when it comes to maintainability of this.
Consider using mkdocs-macros, so that instead of:
## Deployment Repo Content
Use any secret delivery mechanism you prefer. The contract that matters is the final Kubernetes Secret or manifest shape described below.
you just say:
{{ secrets_disclaimer }}
and instead of:
- ArgoCD renders Helm chart `cert-manager`.
- The current template does not read a deploy-repo `values.yaml` for this component.
- The current template does not apply a deploy-repo overlay directory for this component.
you just say:
in frontmatter
----
charts: ['cert-manager']
deploy_overrides:
helm: false
kustomize: false
----and have a macro that renders required boilerplate.
In future we may even come up with a standardized way of defining components so that all of this is generated on the fly.
skrobul
reviewed
Mar 23, 2026
skrobul
reviewed
Mar 23, 2026
Contributor
Author
|
Good points about the macros. Updated to use that. |
There were never any WorkflowTemplates in this directory so its okay to remove where it's gone.
Walk through each of the individual components and flesh out what's needed for them to be setup as well as provide some overall information about what they are and were they're configured or their data comes from.
Based on feedback to some of the secrets and deployment repo references made this change.
Avoid copying around the same wording and instead switch to using macros for the secrets disclaimer and then information about what is used.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Walk through each of the individual components and flesh out what's
needed for them to be setup as well as provide some overall information
about what they are and were they're configured or their data comes
from.