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.

Sign up for GitHub

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

Jump to bottom

DX: Simple chart README.md is confusing #51

Open
mikaelkundert opened this issue Sep 4, 2019 · 0 comments
Open

DX: Simple chart README.md is confusing #51

mikaelkundert opened this issue Sep 4, 2019 · 0 comments

Comments

@mikaelkundert
Copy link

By reading https://github.com/wunderio/charts/tree/master/simple README.md I didn't undestand why this is called simple directory while having Gatsby Helm Chart as a title of README.md.

The description says that it is used in combination with CI, but it doesn't explain why we need this chart in the first place.

Suggestions for DX:

  • Make titles and directory name consistent to avoid confusion
  • If mentioning deriving from drupal-project, explain why or avoid giving information that generates more questions
  • Explain why this chart is needed, explain the problem first
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mikaelkundert