Skip to content

Conversation

@sei-jbooz
Copy link
Contributor

@sei-jbooz sei-jbooz commented Oct 24, 2025

This PR adds documentation for each app in the Crucible Framework. The documentation is in the form of a README.md file placed in the application's chart folder. The README.md details the most popular settings/configurations for each application - listing the setting, a description, and an example value. The initial drafts of this documentation were generated by Claude Code, then reviewed/refined by humans for accuracy, clarity, and consistency.

Summary of changes

  1. Adds a README.md file to each Crucible app's chart folder for documentation.
  2. Updates each application's Chart.yaml to remove Helm default comments. Replaced the Helm default chart description with a one-sentence summary of the application (only parent charts have descriptions, child charts now do not have a description). Added home page and source code links. Reference the Helm Documentation on Charts for their description of the available settings and chart best practices.
  3. Bumps all chart versions (parent and child charts) by one patch version. This allows Helm clients to see the updated chart metadata (e.g., helm show chart sei/topomojo)
  4. Updates the main project README.md file with a new example and tables detailing the available charts.
  5. Consolidates duplicate .gitignore files

sei-dupdyke and others added 29 commits October 24, 2025 17:47
…faults now match the values shipped in charts/alloy/charts/alloy-api/values.yaml, and corrected the SignalR troubleshooting note to

  reference the actual ingress regex /(api|swagger/hubs) on charts/alloy/README.md:287.
  - Corrected charts/topomojo/README.md:78-129 to make it clear the chart leaves core database, OIDC, file-path, and core-behaviour settings unset—operators must supply them or rely on the application defaults—
  removing the previously listed, unverifiable defaults.
  - Adjusted charts/gameboard/README.md:30-51 and charts/gameboard/README.md:115-119 to show that the chart doesn’t provide default URLs or OIDC values and to describe optional knobs without asserting
  unavailable defaults.
@sei-jbooz sei-jbooz requested a review from sei-mpriest October 24, 2025 19:57
@sei-jbooz sei-jbooz requested a review from sei-mkaar October 24, 2025 19:57
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

Successfully merging this pull request may close these issues.

3 participants