From 1384fa5d4a93a04ee87a68bebad9970508a27d28 Mon Sep 17 00:00:00 2001 From: Benjamin Granados <40007659+benjagm@users.noreply.github.com> Date: Tue, 18 Jun 2024 18:01:11 +0200 Subject: [PATCH] Manage adopters directly from the Landscape. (#68) --- CONTRIBUTING.md | 38 +++++++++++++++++++++++++------------- guide.yml | 10 +++++----- 2 files changed, 30 insertions(+), 18 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7d8b09c..da36d34 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,10 +6,10 @@ This document outlines how you can get involved and help improve the JSON Schema - [Code of Conduct 📜](#code-of-conduct-) - [How to Contribute 🚀](#how-to-contribute-) + - [Adding a new Organization 🌐](#adding-a-new-organization-) - [Reporting Bugs 🐞](#reporting-bugs-) - [Suggesting Features 💡](#suggesting-features-) - [Improving the Docs 🚧](#improving-the-docs-) - - [Improving the Landscape 🌐](#improving-the-landscape-) - [Pull Requests 📬](#pull-requests-) - [License 📄](#license-) - [Feedback 💬](#feedback-) @@ -23,17 +23,40 @@ Before contributing, please familiarize yourself with our [Code of Conduct](http There are several ways you can contribute to the JSON Schema website: +* [**Adding a new Organization** 🐞](#adding-a-new-organization-) * [**Reporting Bugs** 🐞](#reporting-bugs-) * [**Suggesting Features** 💡](#suggesting-features-) * [**Improving the Landscape** 🌐](#improving-the-landscape-) +## Adding a new Organization 🌐 + +Do you know about an Organization using JSON Schema? Add it!! + +You can add a new Organization by using the [Adopters form](https://forms.gle/vyFskw1RshJ55LY46) or by submitting a PR to edit landscape.yml file. If your Organization is listed but you like it to be removed, please submit a PR removing it. + +Guidelines: Please follow [the CNCF Landscape guidelines](https://github.com/cncf/landscapeapp?tab=readme-ov-file#adding-and-managing-landscape-entries) to provide the right information. + +Looking for extra credit? We also do [case studies](https://github.com/orgs/json-schema-org/projects/8/views/2) and accept sponsorship via [Open Collective](https://opencollective.com/json-schema). +
+Find out more about case studies +If your Organization would like to share more about what you're doing in public, there's a good chance we'd love to collaborate on a case study. + +Please reach out to us via [our Slack](https://json-schema.org/slack) or creating a new Issue in this repo. + +From experience, these case studies can take some time to develop, write, get approved, and published. It's best if you can find out for sure if you can publish a case study with us as early as possible. If you're at a big organization, you'll likely have to get approval from people who have no idea what you're talking about. Here's some context you can share with them. + +By supporting JSON Schema with a case study, you are documenting its success and your smarts in picking it as a solution. JSON Schema case studies help justify the ongoing financial support required to mature, develop, and support the JSON Schema ecosystem. Case studies also demonstrate the strength of the JSON Schema ecosystem in production today. The next case study could be you. +
+ ### Reporting Bugs 🐞 Encountered a bug on the website? Please use the issue templates to report it. The templates provide guidance on the information needed to help us resolve the issue. ### Suggesting Features 💡 -Do you have an idea for a new feature that could improve the website? Open an issue to share your suggestion. Refer to the "Improving the Landscape" section for details on creating issues. +The website is built with a tool called CNCF Landscape, designed for managing this type of information. While large code edits aren't possible, some customization is achievable through configuration and themes. + +Have an idea for a new feature that works within CNCF Landscape's limitations? Open an issue to discuss your proposal. We use a project board to track website contribution tasks: [link to project board](https://github.com/orgs/json-schema-org/projects/19). ### Improving the Docs 🚧 @@ -48,17 +71,6 @@ We welcome your help in making the JSON Schema Landscape documentation even bett 1. **Make your changes:** Edit the relevant Markdown file. 1. **Create a pull request:** Submit a pull request with your changes and a clear description of the improvements. -## Improving the Landscape 🌐 - -We welcome your help in making the JSON Schema Landscape website even better! Here's how you can contribute: - -The website is built with a tool called CNCF Landscape, designed for managing this type of information. While large code edits aren't possible, some customization is achievable through configuration and themes. - -* Have an idea for a new feature that works within CNCF Landscape's limitations? Open an issue to discuss your proposal. We use a project board to track website contribution tasks: [link to project board](https://github.com/orgs/json-schema-org/projects/19). - - - - ## Pull Requests 📬 We welcome pull requests for bug fixes, new features, and content improvements. diff --git a/guide.yml b/guide.yml index fbbb0b5..cfbc7a7 100644 --- a/guide.yml +++ b/guide.yml @@ -3,18 +3,18 @@ categories: content: | This is a living segmentation of the evolving JSON Schema Ecosystem. Its creation was inspired by by the amazing work done with different CNCF landscapes and the [Landscape2 project](https://github.com/cncf/landscape2). - This first iteration of the landscape focus on JSON Schema Adopters and Sponsors, however the JSON Schema is huge and we are just getting started to map organizations. + This first iteration of the landscape focus on JSON Schema Adopters and Sponsors, however the JSON Schema is huge and we are just getting started to map Organizations. - If you have doubts, have a proposal to improve the JSON Schema Landscape or like to add your organization please create an issue ussing [this link](https://github.com/json-schema-org/landscape/issues/new/choose). + If you have doubts, have a proposal to improve the JSON Schema Landscape or like to add or remove your Organization please check the [contributing guidelines](https://github.com/json-schema-org/landscape/blob/main/CONTRIBUTING.md) for details. subcategories: - subcategory: "Adopters" content: | - The JSON Schema Adopters is a directory that features organizations that have successfully implemented JSON Schema and shared their use case with the Community. It's your go-to place to discover how industry leaders use JSON Schema. Use this [link](https://github.com/json-schema-org/community/blob/main/ADOPTERS.md) to access the list or add your organization. + The JSON Schema Adopters is a directory that features Organizations that have successfully implemented JSON Schema and shared their use case with the Community. It's your go-to place to discover how industry leaders use JSON Schema. Please follow [the contributing guidelines](https://github.com/json-schema-org/landscape/blob/main/CONTRIBUTING.md#adding-a-new-organization-) to add or remove your Organization. - subcategory: "Sponsors" content: | - These are the organizations supporting JSON Schema. If you are interested on becoming a JSON Schema Sponsor please visit our [sponsors page](https://json-schema.org/overview/sponsors) to see all the sponsor opportunities. + These are the Organizations supporting JSON Schema. If you are interested on becoming a JSON Schema Sponsor please visit our [sponsors page](https://json-schema.org/overview/sponsors) to see all the sponsor opportunities. - subcategory: "Tools" content: | - Discover amazing [JSON Schema tooling](https://json-schema.org/tools) to help your organization leverage the benefits of JSON Schema. Because JSON Schema is much more than a Specification, it is a vibrant ecosystem of Validators, Generators, Linters, and other JSON Schema Utilities made by this amazing Community. \ No newline at end of file + Discover amazing [JSON Schema tooling](https://json-schema.org/tools) to help your Organization leverage the benefits of JSON Schema. Because JSON Schema is much more than a Specification, it is a vibrant ecosystem of Validators, Generators, Linters, and other JSON Schema Utilities made by this amazing Community. \ No newline at end of file