-
-
Notifications
You must be signed in to change notification settings - Fork 280
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
Single source of truth #780
Comments
I see and agree the source of truth of the spec can become unclear. In fact, I think it becomes less clear for contributors than for users.
|
I guess that's automatically implied that specification itself is the single source of truth. Would be quite uncommon to have this explicitly defined in the specification itself. IMHO having it in README suffice, but don't mind having it in specification itself as well, although as I mentioned it's uncommon. |
I believe most users (including potential ones) won't read the README file, but rather navigate through the AsyncAPI website. |
Just an idea: how about mentioning it in README and the website? I understand that the website is generated from the markdown document, so we just add the sentence to the website templates as well. |
Sure, this is what I meant by:
|
@smoya ahh sorry I misunderstood. I've issued a PR to the website adding the sentence there as well: asyncapi/website#743 |
This issue has been automatically marked as stale because it has not had recent activity 😴 It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation. There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model. Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here. Thank you for your patience ❤️ |
I think this has been done already. Let me know otherwise, @char0n. |
I confirm, it's been merged into master as editorial change - 02393d1 |
Sometimes there are situations when it is not clear if the source of truth should be the JSON Schema or the markdown specification. To remedy this situation, we can explicitly state following in main README file:
Whenever there is a conflict, the specification itself is the source of truth before anything else.
The text was updated successfully, but these errors were encountered: