You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Right now, the readme.md of all interfaces has a few issues:
unclear what the purpose of the introductory section is, given that it's always some paraphrase of
"this interface specification is meant to define what a charm providing or requiring a relation with this relation interface."
too much variability in the way the 'expectations' are stated. If the schema (pydantic or json) is not clear enough, then the tests should make it bulletproof-obvious what a charm is or is not expected to do.
there is still some lingering confusion in some specifications of whether the norms are behavioral or purely structural (i.e. if the ingress provider is actually expected to do something beyond replying with a syntactically correct url).
the 'directionality' graphs are somewhat useful, but also that's information that can be derived from the schema. Perhaps we can make the schemas more central and visualize them better?
I think this repo/project would benefit from some cleanup across the readme's to:
reduce duplication
uniform things across the interfaces
make the language more clear in general
The text was updated successfully, but these errors were encountered:
I think we should clarify the purpose of the readme and the target audience. If/when it will eventually land in charmhub as interface documentation, we need to make sure it's useful and neat.
Right now, the readme.md of all interfaces has a few issues:
I think this repo/project would benefit from some cleanup across the readme's to:
The text was updated successfully, but these errors were encountered: