Skip to content

update documentation#36

Open
alvnukov wants to merge 47 commits intoflant:mainfrom
alvnukov:flant/pr-prep
Open

update documentation#36
alvnukov wants to merge 47 commits intoflant:mainfrom
alvnukov:flant/pr-prep

Conversation

@alvnukov
Copy link
Copy Markdown
Contributor

No description provided.

Alexandr Vnukov and others added 30 commits October 16, 2022 17:39
* [feature] add includes from files

* fix

* fix

Co-authored-by: Alexandr Vnukov <alexandr.vnukov@flant.com>
* [feature] add includes from files

* fix

* fix

* [fix] include from file

Co-authored-by: Alexandr Vnukov <alexandr.vnukov@flant.com>
Co-authored-by: Alexandr Vnukov <alexandr.vnukov@flant.com>
Co-authored-by: Alexandr Vnukov <alexandr.vnukov@flant.com>
* [fix] secrets create

* [fix] configMap data

Co-authored-by: Alexandr Vnukov <alexandr.vnukov@flant.com>
Co-authored-by: Alexandr Vnukov <alexandr.vnukov@flant.com>
Co-authored-by: Alexandr Vnukov <alexandr.vnukov@flant.com>
Co-authored-by: Alexandr Vnukov <alexandr.vnukov@flant.com>
Co-authored-by: Alexandr Vnukov <alexandr.vnukov@flant.com>
Co-authored-by: Alexandr Vnukov <alexandr.vnukov@flant.com>
Co-authored-by: Alexandr Vnukov <alexandr.vnukov@flant.com>
* [fix] remove vars with null value from configmapYaml

* [fix] change ci

Co-authored-by: Alexandr Vnukov <alexandr.vnukov@flant.com>
* [fix] remove vars with null value from configmapYaml

* [fix] change ci

* [fix] add recursive deleted empty map in configmapsYaml

Co-authored-by: Alexandr Vnukov <alexandr.vnukov@flant.com>
… in CI

- Reworked README into a user-facing landing page with quick start, supported resources, and include/merge examples\n- Added a full documentation portal under docs/: handbook, values reference, cookbook, and operations playbook\n- Added docs index (docs/README.md) with role-based reading paths and onboarding flow\n- Added comprehensive JSON schema for tests/.helm/values.yaml and documented it as the validation source\n- Added CI step to validate values against schema via helm lint before render checks\n- Improved guidance around global._includes recursion, include precedence, and practical merge patterns
- Added dedicated CI workflow for PR/branch validation with schema lint, render checks, and snapshot diff\n- Restricted release workflow to main/manual triggers and kept publishing flow there\n- Added contract test chart to verify global._includes behavior: recursive map merge, include order precedence, local overrides, _include concatenation, and env-map resolution\n- Updated README and values reference docs to reflect actual env-map merge behavior\n- Ignored local IDE metadata directory (.idea/)
…patibility

- Clarified positioning: Helm is fully supported, while werf is compatible and often convenient in team workflows\n- Added explicit guidance that environments are selected via global.env\n- Replaced remaining werf-centric command examples with Helm-based commands in user docs\n- Updated CI and release workflows to use Helm template/lint flow for render validation
- Added parameter index with direct links from parameter names to reference sections and cookbook examples\n- Added use-case map (task -> parameter -> example -> checks) for faster onboarding and troubleshooting\n- Added anchors and cross-links across docs (top links, section navigation, back-to-index links)\n- Updated README/docs entry points to emphasize discoverability and fast navigation\n- Tightened values schema typing for string-based raw YAML fields and global.env semantics\n- Clarified merge/list behavior in docs to match actual library behavior
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.

1 participant