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

Initial proposal for JSON Schema blog guidelines #482

Merged
merged 9 commits into from
Oct 5, 2023

Conversation

benjagm
Copy link
Collaborator

@benjagm benjagm commented Sep 13, 2023

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

Copy link
Member

@gregsdennis gregsdennis left a 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.

Copy link
Member

@jdesrosiers jdesrosiers left a 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.

docs/blog-guidelines.md Outdated Show resolved Hide resolved
@benjagm
Copy link
Collaborator Author

benjagm commented Sep 14, 2023

does it address the issue of that PR?

I think the document has a good baseline for cases like that one in different ways:

  1. We are restricting who can send blog posts with this sentence "The JSON Schema blog serves as a channel for project maintainers and contributors, implementation maintainers and JSON Schema Champions to share content with the JSON Schema Community." With this phrase we intend to express that the blog is from the community to the community and only relevant/trusted contributors of the community can publish here and in this case the authors are new joiners, they don't have that level of Community reputation.
  2. We are restricting the types of blog posts. This is not directly restricting this type of content but it gives some soft arguments as well.
  3. We are explicitly saying that there is review process and articles could be rejected with this sentence "If the article it’s not suitable for the JSON Schema blog, we will provide feedback and direction."
  4. We introduce clarification that the content should be beneficial to the community with this sentence: "Critical commentary or broad issues must be approached with sensitivity, professionalism, and tact in a way that is beneficial and positive for the Community." In the current case this argument IMHO is strong enough to take a decision to protect the JSON Schema Community benefit.

@benjagm
Copy link
Collaborator Author

benjagm commented Sep 14, 2023

I also wonder if this needs to be in the blog repo instead of the community repo.

The blog repo will be soon deprecated as the blog is integrated with the site in the new website. I see 2 options here:

  1. Locate the md file in the blog section in the new website repo.
  2. keeping together these kind of contribution policies under the community repo. Some examples:

Co-authored-by: Jason Desrosiers <[email protected]>
@gregsdennis
Copy link
Member

@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?

@benjagm
Copy link
Collaborator Author

benjagm commented Sep 14, 2023

if you think we're covered

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.

@benjagm
Copy link
Collaborator Author

benjagm commented Sep 14, 2023

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?

100% Yes!

Copy link
Member

@Relequestual Relequestual left a 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).

docs/blog-guidelines.md Outdated Show resolved Hide resolved
docs/blog-guidelines.md Outdated Show resolved Hide resolved
docs/blog-guidelines.md Outdated Show resolved Hide resolved
docs/blog-guidelines.md Outdated Show resolved Hide resolved
docs/blog-guidelines.md Outdated Show resolved Hide resolved
docs/blog-guidelines.md Outdated Show resolved Hide resolved
@Relequestual
Copy link
Member

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?

Me: Oh, we could automate copying files across repos when updated.
Reads suggest
Me: Yeah, that's a FAR better idea. Thanks Greg.

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.

@benjagm
Copy link
Collaborator Author

benjagm commented Sep 15, 2023

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.

@benjagm
Copy link
Collaborator Author

benjagm commented Sep 15, 2023

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.

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.
@benjagm
Copy link
Collaborator Author

benjagm commented Sep 18, 2023

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.

Copy link
Member

@Relequestual Relequestual left a 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

@benjagm benjagm merged commit 220388a into main Oct 5, 2023
@benjagm benjagm deleted the benjagm-blog-guidelines branch October 5, 2023 16:09
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.

4 participants