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

Update docs #112

Merged
merged 6 commits into from Jan 19, 2023
Merged

Update docs #112

merged 6 commits into from Jan 19, 2023

Conversation

sed-i
Copy link
Contributor

@sed-i sed-i commented Jan 16, 2023

Currently, alertmanager docs on charmhub have the following structure:

All of the above, except Relations, is already incorporated in the README.md file.
I think the Relations doc can be entirely incorporated in metadata.yaml.

Fixes #109.

README.md Outdated Show resolved Hide resolved
@Abuelodelanada
Copy link
Contributor

Why do you think the Relations doc can be omitted entirely?

Right now in Prometheus we already have Relations in README.md. From my point of view, we should have a a standardised way to write the README.md

Can we remove from this PR the modifications in charm.py and tests and create another PR with that?

@sed-i
Copy link
Contributor Author

sed-i commented Jan 17, 2023

Why do you think the Relations doc can be omitted entirely?

Bad phrasing on my part. Rephrased.

Right now in Prometheus we already have Relations in README.md.

After trimming down all the superfluous "any charm with X relation over the Y interface" statements, I wasn't left with much. Whatever left I moved into metadata.yaml.

From my point of view, we should have a a standardised way to write the README.md

Agreed. I'm proposing to describe relations in-context (inside metadata.yaml).

Can we remove from this PR the modifications in charm.py and tests and create another PR with that?

Good point. Split into #114

@sed-i sed-i merged commit bc3f744 into main Jan 19, 2023
@sed-i sed-i deleted the feature/doc-fix branch January 19, 2023 04:41
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.

The readme is not consistent with the actual usage
3 participants