docs: Add comprehensive chart structure documentation #165
Conversation
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
aldbr
reviewed
Aug 6, 2025
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for the DiracX Helm chart structure, explaining the components, initialization process, and configuration patterns. The documentation replaces placeholder content with detailed explanations of chart dependencies, bootstrap sequence, secret management, and deployment modes.
- Replaces single-line placeholder with detailed 225-line chart structure documentation
- Documents all chart dependencies, initialization jobs, and secret management patterns
- Clarifies development vs production deployment modes and bootstrap sequence
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/admin/explanations/chart-structure.md | Comprehensive documentation of DiracX chart structure, components, and deployment process |
| docs/admin/how-to/rotate-a-secret.md | New guide for rotating various DiracX secrets including database, authentication, and storage credentials |
Comments suppressed due to low confidence (1)
docs/admin/explanations/chart-structure.md:163
- The CS Store persistent storage warning mentioned in the PR description is missing. The documentation should clarify that CS Store persistent storage is for development only, as stated in the PR summary.
- **CS Store Volume** (`diracx/cs-store-volume.yml`): Persistent storage for Configuration Store data (development only)
| - **Authentication services**: Identity providers and certificate management | ||
| - **Initialization jobs**: Bootstrap processes for databases, secrets, and configuration | ||
|
|
||
| The structures is heavily inspired by the one provided for GitLab due to their similar use case of providing a generic helm chart for a wide variety of installations. |
There was a problem hiding this comment.
The word 'structures' should be 'structure' (singular form).
Suggested change
| The structures is heavily inspired by the one provided for GitLab due to their similar use case of providing a generic helm chart for a wide variety of installations. | |
| The structure is heavily inspired by the one provided for GitLab due to their similar use case of providing a generic helm chart for a wide variety of installations. |
docs/admin/how-to/rotate-a-secret.md
Outdated
|
|
||
| DiracX requires various secrets to operate securely. This guide explains how to rotate these secrets for maintenance or security purposes. | ||
|
|
||
| Throughout this page you'll need the release name you used when installing with help (typically `diracx`). |
There was a problem hiding this comment.
The phrase 'installing with help' should be 'installing with helm' (referring to the Helm package manager).
Suggested change
| Throughout this page you'll need the release name you used when installing with help (typically `diracx`). | |
| Throughout this page you'll need the release name you used when installing with helm (typically `diracx`). |
chrisburr
force-pushed
the
doc-chart-structure-comprehensive
branch
2 times, most recently
from
7539f81 to
8541977
Compare
Replaces placeholder content with detailed explanation of: - Chart dependencies and their purposes - Main DiracX components (services, web, configuration) - Initialization job sequence and bootstrap process - Configuration structure for dev/prod modes - Storage volumes and deployment modes Includes warning that bundled dependencies are for dev/test only. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
chrisburr
force-pushed
the
doc-chart-structure-comprehensive
branch
from
8541977 to
d99f2e5
Compare
chrisburr
force-pushed
the
doc-chart-structure-comprehensive
branch
from
4edbfc7 to
0756d26
Compare
chaen
approved these changes
Aug 6, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Summary