Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MG-196 - Sync Kubernetes docs with devops docs #197

Merged
merged 3 commits into from
Sep 13, 2024

Conversation

JeffMboya
Copy link
Contributor

What does this do?

This PR syncs the Kubernetes documentation with the DevOps documentation by ensuring both are up to date and consistent by documenting the use of helm-docs to automatically generate and update documentation based on the latest changes in Chart.yaml, values.yaml, README.md.gotmpl, and other key files in the charts.

Which issue(s) does this PR fix/relate to?

List any changes that modify/break current functionality

None

Have you included tests for your changes?

No

Did you document any new/modified functionality?

Yes

Notes

Signed-off-by: JeffMboya <[email protected]>
Signed-off-by: JeffMboya <[email protected]>
@JeffMboya JeffMboya changed the title MG-196 - Sync kubernetes docs with devops docs MG-196 - Sync Kubernetes docs with devops docs Sep 11, 2024
Example with release name and flag:

```bash
helm install my-magistrala magistrala-devops/magistrala --version 1.0.6
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where does this version come from? We should align releases with Magistrala versions.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dborovcanin the previous version documented on the chart.yaml was 1.0.4 and two changes have been made since then. Let me align the releases with MG versions

@dborovcanin dborovcanin merged commit 9f110eb into absmach:main Sep 13, 2024
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.

Feature: Sync kubernetes docs with devops docs
2 participants