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

[kube-prometheus-stack]docs: add a FAQ #4775

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

davhdavh
Copy link

@davhdavh davhdavh commented Aug 7, 2024

What this PR does / why we need it

Add a FAQ, because this helm is severely lacking in a bit of help for common setups and issues.

Checklist

  • DCO signed
  • [-] Chart Version bumped
  • Title of the PR starts with chart name (e.g. [prometheus-couchdb-exporter])

Signed-off-by: Dennis Haney <dennishaney11@gmail.com>
@GMartinez-Sisti
Copy link
Member

I like the concept, but I think we should add this to another file -> FAQ.md, and link it from the main README since that file is already huge.

@davhdavh
Copy link
Author

davhdavh commented Aug 8, 2024

It wont show up on e.g. artifacthub if it isn't in the readme.
Besides, the current readme file is way way under-documented and is mostly just the same list of CRD fixes 10 times.

@GMartinez-Sisti
Copy link
Member

It wont show up on e.g. artifacthub if it isn't in the readme. Besides, the current readme file is way way under-documented and is mostly just the same list of CRD fixes 10 times.

IMHO an FAQ is not something you need on the main README, the README file should contain only information about the chart, how to deploy and how to upgrade, everything else can be on other files. With this change the README ends up with 1321 lines, and if you go all the way to the end we already have some topics that would fit an FAQ, e.g. Work-Arounds for Known Issues, Migrating from stable/prometheus-operator chart and Redeploy with new name (downtime), to name a few. I would be happy to send these to the new FAQ file and just add a link.

However note that I don't oppose adding the FAQ to the README, if you feel that brings value, at least we could create a table of contents for the main topics and add it on top of the README file to make it a little easier to understand. This is a good example: https://github.com/runatlantis/helm-charts/tree/main/charts/atlantis#links. WDYT?

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