Update diagram for operator flow #958
Assignees
Labels
documentation
Improvements or additions to documentation
operator
Issues pertaining to the UDS Operator (Pepr)
Comments
mjnagel
added
documentation
|
We may also want to consider how this interacts/could be combined with #957, but would want to ensure it doesn't get too messy. |
mjnagel
assigned mjnagel, noahpb, UnicornChance and sgettys and unassigned catsby, mjnagel and noahpb
5 tasks
5 tasks
5 tasks
UnicornChance
added a commit
that referenced
this issue
Jan 17, 2025
## Description Create diagrams ( both for the doc site and for dev docs) of how the pepr operator works for different resources. These svg and jpg files will be uploaded to the google drive as well as the draw io file. Also refactored the configuration operator doc into three separate docs in it's own drop down, with the inclusion of diagrams it was getting too big. The overview doc is the only one that has new content, everything else is copy and paste. These diagrams are created with dynamic light / dark mode backgrounds. They also match up with new company branding colors and fonts. ## Related Issue Fixes #958 ## Type of change - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [x] Other (security config, docs update, etc) ## Steps to Validate - should be able to use the new dev-docs to view these changes and what they look like in the doc site: `uds run dev-docs` and go to the `Configuration/UDS Operator` drop down to view changes and diagrams. ## Checklist before merging - [x] Test, docs, adr added or updated as needed - [x] [Contributor Guide](https://github.com/defenseunicorns/uds-template-capability/blob/main/CONTRIBUTING.md) followed --------- Co-authored-by: Micah Nagel <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
We currently have an out of date flow diagram for the operator/package CR reconciliation. This should be updated to reflect the current state of the operator (noticeable pieces missing are monitoring and sso). It should also be moved somewhere inside of the
docs/folder to ensure it is present in the docs site as a reference. When updating and moving to the docs site we will want to ensure it is still created using code and presents/renders well on the documentation site (at a glance it may require some extra work to get Mermaid supported on Starlight/Astro, or switch to a different diagram tool for creation).Definition of done: Operator flow diagram includes all current operator reconciliation steps and is rendered on the docs site.
The text was updated successfully, but these errors were encountered: