doc: update CRD descriptions and translations#32
Draft
drey wants to merge 2 commits into
Draft
Conversation
Signed-off-by: Ilya Drey <ilya.drey@flant.com>
Signed-off-by: Ilya Drey <ilya.drey@flant.com>
There was a problem hiding this comment.
Pull request overview
This PR updates end-user and API documentation around the operator-helm CRDs (English/Russian module docs plus CRD schema descriptions) and makes small robustness/security-related tweaks to the kind-based e2e installation script.
Changes:
- Refines/extends English and Russian module README content, including a roadmap/info callout and clearer CRD descriptions/limitations.
- Updates CRD description text for HelmClusterAddonRepository/HelmClusterAddonChart and Russian CRD doc variants.
- Adjusts the kind e2e helper script for stricter OS detection and adds a registry login step for EE installs.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/e2e/scripts/kind-d8-ci.sh | Tightens OS detection behavior and adds registry login for EE flows; minor memory-check guard improvements. |
| docs/README.md | Expands English module overview with roadmap/info block and CRD/limitations sections. |
| docs/README.ru.md | Expands Russian module overview with roadmap/info block and CRD/limitations sections. |
| crds/helmclusteraddons.yaml | Updates generated CRD output (notably root schema description changes). |
| crds/helmclusteraddonrepositories.yaml | Improves CRD root description for repository CRD. |
| crds/helmclusteraddoncharts.yaml | Improves CRD root description for chart CRD. |
| crds/doc-ru-helmclusteraddons.yaml | Expands Russian CRD description text for HelmClusterAddon. |
| crds/doc-ru-helmclusteraddonrepositories.yaml | Improves Russian CRD description for repository CRD. |
| crds/doc-ru-helmclusteraddoncharts.yaml | Improves Russian CRD description for chart CRD. |
| api/v1alpha1/helm_cluster_addon.go | Updates Go doc comment for HelmClusterAddon type. |
| api/v1alpha1/helm_cluster_addon_repository.go | Updates Go doc comment for HelmClusterAddonRepository type. |
| api/v1alpha1/helm_cluster_addon_chart.go | Updates Go doc comment for HelmClusterAddonChart type. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+35
to
+36
| // HelmClusterAddon represents a single cluster-wide installation of a Helm chart, which may include custom resource definitions (CRDs) and requires cluster-admin permissions to deploy. Only one instance of a specific chart can be installed at any given time. | ||
|
|
| EOF | ||
|
|
||
| if [[ -n "$D8_LICENSE_KEY" ]]; then | ||
| docker login -u license-token -p $D8_LICENSE_KEY |
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
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.
No description provided.