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

docs(ghc): IDT-884 add documentation for Golden Helm Chart #18

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

BaturaySoysal-TomTom
Copy link
Collaborator

Pull Request Description

This PR adds the user documentation for Golden Helm Chart.

Changes Made

  • Add Golden Helm Chart documentation.

Why?

This is requested by Golden Helm Chart users and CRA team.

Related Jira Issue(s)

Type of change

  • Documentation content changes

@BaturaySoysal-TomTom BaturaySoysal-TomTom marked this pull request as draft March 15, 2024 15:28
@BaturaySoysal-TomTom BaturaySoysal-TomTom marked this pull request as ready for review April 12, 2024 14:09
Copy link

@DavidBaumgold-TomTom DavidBaumgold-TomTom left a comment

Choose a reason for hiding this comment

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

I'm not sure who is the expected audience of this documentation. Do we assume that they are familiar with Helm and Helm Charts, or not? If they are following the "golden path", they may not be familiar with the tools and are just trying to use the defaults as much as possible; if so, we should make sure that this README explains some of the underlying concepts behind Helm Charts, so the reader has a better chance to know what they are doing. On the other hand, if the intended audience should already know about Helm and Helm Charts, then we can probably remove some unnecessary detail and make these docs more streamlined.

@BaturaySoysal-TomTom
Copy link
Collaborator Author

Some additional feedback I received from @AdrianSzwajkowski-TomTom:

  • We should add some working examples for different use cases. This would speed up the onboarding process for first-time users.
  • (As also suggested by David) We should provide some additional information/links for people who are not familiar with Helm, ESO, etc.

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.

2 participants