From 50a22543fa9347746053fe059c561f560a4c7154 Mon Sep 17 00:00:00 2001 From: Valeria Hernandez Luzardo Date: Sat, 31 Aug 2024 16:52:48 +0200 Subject: [PATCH 1/2] Update Improving documentation section Add more info on how to contribute to JSON Schema documentation --- CONTRIBUTING.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 75a3a9d1e..ae954e995 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -58,7 +58,11 @@ To publish a case study, we encourage you to join `#adopters` channel in our [Sl ### 📋 Improving the Documentation -If you would like to join the efforts to improve the JSON Schema Documentation, we encourage you to check our [documentation board](https://github.com/orgs/json-schema-org/projects/16) to get a sense of the pending issues and who is doing what. We encourage you to join the discussion on the [issue #421](https://github.com/json-schema-org/community/issues/421) so you can see the long term vision for our docs. We also invite you to join the discussion in `#documentation` channel in our [Slack workspace](https://json-schema.org/slack). +If you would like to join the efforts to improve the JSON Schema Documentation, we encourage you to check our [documentation board](https://github.com/orgs/json-schema-org/projects/16) to get a sense of the pending issues and who is doing what. Join the discussion on the [issue #421](https:[Slack workspace](https://json-schema.org/slack) so you can see the long term vision for our docs and stay updated. + +If you would like to work on an existing issue, express your interest in a comment and tag @benjagm for visibility. + +If you would like to propose changes, create an issue and use the _Documentation template_ to describe the changes you're proposing. After that, you can self-assign the issue or leave it for someone else to work on it. ### 📋 Improving the Website From dd60fc3019ba670504236e3ce61c0741beeb9946 Mon Sep 17 00:00:00 2001 From: Valeria Hernandez Luzardo Date: Sun, 29 Sep 2024 10:25:19 -0600 Subject: [PATCH 2/2] Update CONTRIBUTING.md Improve docs contribution guidance: Reference CONTRIBUTING-docs.md and style-guide.md --- CONTRIBUTING.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ae954e995..34a5617ae 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -58,11 +58,7 @@ To publish a case study, we encourage you to join `#adopters` channel in our [Sl ### 📋 Improving the Documentation -If you would like to join the efforts to improve the JSON Schema Documentation, we encourage you to check our [documentation board](https://github.com/orgs/json-schema-org/projects/16) to get a sense of the pending issues and who is doing what. Join the discussion on the [issue #421](https:[Slack workspace](https://json-schema.org/slack) so you can see the long term vision for our docs and stay updated. - -If you would like to work on an existing issue, express your interest in a comment and tag @benjagm for visibility. - -If you would like to propose changes, create an issue and use the _Documentation template_ to describe the changes you're proposing. After that, you can self-assign the issue or leave it for someone else to work on it. +Want to contribute to improving the JSON Schema documentation? We have documented processes and style guidelines in separate guides. We invite you to read both documents, as they will help you get started and create consistent documentation. ### 📋 Improving the Website