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

Understand welkin #1015

Merged
merged 16 commits into from
Jan 10, 2025
Merged

Understand welkin #1015

merged 16 commits into from
Jan 10, 2025

Conversation

cristiklein
Copy link
Collaborator

⚠️ IMPORTANT ⚠️: This is a public repository. Make sure to not disclose:

  • personal data beyond what is necessary for interacting with this Pull Request;
  • business confidential information, such as customer names.

Quality gates:

  • I'm aware of the Contributor Guide and did my best to follow the guidelines.
  • I'm aware of the Glossary and did my best to use those terms.

While drafting an operations manual for a customer, we realized that we don't really have for the platform administrator a page which describes the "forest" before describing the "trees". This PR bridges this gap.

Copy link
Contributor

@anders-elastisys anders-elastisys left a comment

Choose a reason for hiding this comment

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

Great work, added some nits and a few comments.
Something I am missing is perhaps to mention that Welkin apps is built on Helmfile and that our configuration files are used to configure the Helm charts that we have as part of our Helmfile stack(s).

docs/operator-manual/understand-welkin.md Outdated Show resolved Hide resolved
docs/operator-manual/understand-welkin.md Outdated Show resolved Hide resolved
docs/operator-manual/understand-welkin.md Show resolved Hide resolved
docs/operator-manual/understand-welkin.md Outdated Show resolved Hide resolved
Copy link
Contributor

@AlbinB97 AlbinB97 left a comment

Choose a reason for hiding this comment

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

Amazing work so far! Added a bunch of comments ☺️

docs/operator-manual/understand-welkin.md Outdated Show resolved Hide resolved
docs/operator-manual/understand-welkin.md Outdated Show resolved Hide resolved
docs/operator-manual/understand-welkin.md Outdated Show resolved Hide resolved
docs/operator-manual/understand-welkin.md Show resolved Hide resolved
docs/operator-manual/understand-welkin.md Outdated Show resolved Hide resolved
docs/operator-manual/understand-welkin.md Show resolved Hide resolved
docs/operator-manual/understand-welkin.md Show resolved Hide resolved
Copy link
Contributor

@anders-elastisys anders-elastisys left a comment

Choose a reason for hiding this comment

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

LGTM, great start for explaining how all of this works and is set up. 🚀

Copy link
Contributor

@llarsson llarsson left a comment

Choose a reason for hiding this comment

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

I'd love to see some changes, see comments, but in general, I definitely approve of this!

docs/operator-manual/understand-welkin.md Outdated Show resolved Hide resolved
docs/operator-manual/understand-welkin.md Show resolved Hide resolved
docs/operator-manual/understand-welkin.md Outdated Show resolved Hide resolved
docs/operator-manual/understand-welkin.md Show resolved Hide resolved
docs/operator-manual/understand-welkin.md Show resolved Hide resolved
docs/operator-manual/understand-welkin.md Show resolved Hide resolved
@cristiklein cristiklein merged commit 82829b1 into main Jan 10, 2025
1 check passed
@cristiklein cristiklein deleted the understand-welkin branch January 10, 2025 10:00
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.

5 participants