-
-
Notifications
You must be signed in to change notification settings - Fork 41
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
Initial proposal for JSON Schema blog guidelines #482
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is good, but does it address the issue of that PR? It could be argued that the critism it contains is long-term beneficial for JSON Schema. They're making recommendations for changing the spec because they feel that users would benefit from JSON Schema working a bit (albeit fundamentally) differently.
I don't think that's appropriate for a post on our blog, though. I think those kinds of things need to be realized as issues where we can discuss the benefits of the changes, and potentially (eventually) incorporate some of them. Then, later, we can invite them to write a post about the full experience of recommending changes and seeing them through.
I also wonder if this needs to be in the blog repo instead of the community repo.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Found one typo, but otherwise it looks great.
I think the document has a good baseline for cases like that one in different ways:
|
The blog repo will be soon deprecated as the blog is integrated with the site in the new website. I see 2 options here:
|
Co-authored-by: Jason Desrosiers <[email protected]>
@benjagm if you think we're covered and we can say, "Thanks, but no. Let's discuss other options elsewhere," then I'm happy. If we want to keep all policy documents together, which I'm not opposed to (e.g. for housekeeping purposes), could we at least add a "guidelines"-ish file to the blog folder that simply links to the policy doc? |
I think we will be much better covered than before this situation, and we will have way to improve this policy if required as new cases appear. |
100% Yes! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall, content looks great.
I've added a few small nits and questions.
(And I made a PR to the CNCF version of this document).
Me: Oh, we could automate copying files across repos when updated. In fact, that sort of thing should probably be a CONTRIBUTING.md in the new website repo. May need some more general guidance, and then also the blog specific guidance. |
Co-authored-by: Ben Hutton <[email protected]>
Co-authored-by: Ben Hutton <[email protected]>
Co-authored-by: Ben Hutton <[email protected]>
Co-authored-by: Ben Hutton <[email protected]>
Co-authored-by: Ben Hutton <[email protected]>
Thanks everyone for the reviews and comments. I tried to address all the changes with the last PR. As soon as we get this approved I'll work on adding the ish to the repos. |
I'll add a CONTRIBUTING.md to the new website repo before the new website roll-out. |
I realized that we don't have a definition of JSON Schema Champion what introduces some ambiguity here, this is way I am adding a definition.
I realized that we don't have a definition of JSON Schema champion and that introduces some ambiguity in the expectations, this is why I just added a definition. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for your revisions
Summary:
Related: #474
This PR provides an initial version of blog guidelines to better handle future external contributions.
Mostly inspired by CNCF Blog guidelines.
Do you think resolving this issue might require an Architectural Decision Record (ADR)? (significant or noteworthy)
No