-
-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #41 from Michael-Obele/main
Enhance Documentation & Development Experience
- Loading branch information
Showing
2 changed files
with
164 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| ## Contributing to the JSON Schema Website | ||
|
|
||
| This document outlines how you can get involved and help improve the JSON Schema website. We appreciate all contributions! | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| - [Code of Conduct 📜](#code-of-conduct-📜) | ||
| - [How to Contribute 🚀](#how-to-contribute-🚀) | ||
| - [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-💬) | ||
|
|
||
| ## Code of Conduct 📜 | ||
|
|
||
| Before contributing, please familiarize yourself with our [Code of Conduct](https://github.com/json-schema-org/.github/blob/main/CODE_OF_CONDUCT.md). | ||
|
|
||
|
|
||
| ## How to Contribute 🚀 | ||
|
|
||
| There are several ways you can contribute to the JSON Schema website: | ||
|
|
||
| * [**Reporting Bugs** 🐞](#reporting-bugs-🐞) | ||
| * [**Suggesting Features** 💡](#suggesting-features-💡) | ||
| * [**Improving the Website** 🌐](#improving-the-website-🌐) | ||
|
|
||
| ### 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. | ||
|
|
||
| ### Improving the Docs 🚧 | ||
|
|
||
| We welcome your help in making the JSON Schema Landscape documentation even better! Here's how you can contribute: | ||
|
|
||
| * **Spot a mistake? Have a suggestion for clarity?** You can directly edit the Markdown files used for the documentation in a pull request. | ||
|
|
||
|
|
||
| * **Limited content type changes:** If you have ideas for improvements that don't involve code changes (like typos, grammar, or better explanations), you can follow these steps: | ||
|
|
||
| 1. **Identify your contribution:** Is it a documentation fix, improved clarity, or a suggestion for better phrasing? | ||
| 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. | ||
|
|
||
| * If your pull request addresses a specific issue, please reference the issue number in your pull request description. This helps us link and close the issue when the pull request is merged. | ||
| * Generally, pull requests should be submitted to the `main` branch. | ||
| * Most pull requests will be open for review for at least 14 days. Minor fixes may be merged more quickly once approved by a project member. | ||
|
|
||
| For more details on creating pull requests, refer to GitHub's documentation: [https://docs.github.com/en/pull-requests](https://docs.github.com/en/pull-requests) | ||
|
|
||
| ## License 📄 | ||
|
|
||
| The contents of this repository are [licensed under](https://github.com/json-schema-org/website/blob/main/CONTRIBUTING.md#-license) either the BSD 3-clause license *or* the Academic Free License v3.0. | ||
|
|
||
| ## Feedback 💬 | ||
|
|
||
| We welcome feedback on this contribution process. You can share your thoughts informally on our Slack server: link to Slack workspace: [https://json-schema.org/slack](https://json-schema.org/slack) or formally through our Community Discussions: link to Discussions: [https://github.com/json-schema-org/community/discussions](https://github.com/json-schema-org/community/discussions). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,86 @@ | ||
| Welcome to the JSON Schema Landscape project. | ||
| ## JSON Schema Landscape | ||
|
|
||
| [](https://json-schema.org) | ||
|
|
||
| ## Empowering you to navigate the JSON Schema Ecosystem | ||
|
|
||
| We're thrilled to announce the launch of the JSON Schema Landscape! This comprehensive resource is designed to be your one-stop shop for exploring the ever-evolving JSON Schema ecosystem. | ||
|
|
||
| ## The JSON Schema Landscape: Your Map to the Ecosystem | ||
|
|
||
| This resource catalogs and organizes the key players in the JSON Schema ecosystem. Explore tools, libraries, and validation solutions to streamline your JSON Schema development. | ||
|
|
||
| ## What benefits do you gain from the JSON Schema Landscape? | ||
|
|
||
|
|
||
| * **Streamline development:** Find essential tools and libraries. | ||
| * **Align solutions:** Discover options that perfectly fit your needs. | ||
| * **Gain insights:** Understand the current JSON Schema landscape. | ||
|
|
||
| ## Dive deeper! Explore the Extensive JSON Schema Ecosystem | ||
|
|
||
|
|
||
| Visit the deployed website at [https://landscape.json-schema.org/](https://landscape.json-schema.org/) and delve into the rich ecosystem of tools and resources available. | ||
|
|
||
| ## Run Locally | ||
|
|
||
| This section is for those interested in contributing or running the landscape website locally. | ||
|
|
||
| **Prerequisites:** | ||
|
|
||
| * Install Landscape2 first. Find pre-built versions for your system on the Landscape2 releases page: [https://github.com/cncf/landscape2](https://github.com/cncf/landscape2) | ||
|
|
||
| **Building the Website:** | ||
|
|
||
| The build process creates the website from data files. Run this command in your terminal: | ||
|
|
||
| ```bash | ||
| landscape2 build \ | ||
| --data-file landscape.yml \ | ||
| --settings-file settings.yml \ | ||
| --guide-file guide.yml \ | ||
| --logos-path logos \ | ||
| --output-dir build | ||
| ``` | ||
|
|
||
| **Running the Website Locally:** | ||
|
|
||
| Once built, use Landscape2 to serve the website locally: | ||
|
|
||
| ```bash | ||
| landscape2 serve --landscape-dir build | ||
| ``` | ||
|
|
||
| This starts a local server and opens the website in your web browser at http://127.0.0.1:8000. | ||
|
|
||
|
|
||
|
|
||
| ## Contributing | ||
|
|
||
| * We warmly welcome your contributions to this project! A dedicated [CONTRIBUTING.md](CONTRIBUTING.md) file outlines the various ways you can get involved, including: | ||
| * Reporting bugs and requesting features | ||
| * Contributing code | ||
| * Improving documentation | ||
| * Adding new entries to the landscape | ||
| * Improving the user interface | ||
|
|
||
| ## License | ||
| The contents of this repository are licensed under either the BSD 3-clause license or the Academic Free License v3.0. See the [license file](https://github.com/json-schema-org/website/blob/main/CONTRIBUTING.md#-license) for more details. | ||
|
|
||
|
|
||
| ## Contact | ||
|
|
||
| For any questions or feedback, please feel free to open an issue on this repository. | ||
|
|
||
| ## Get Involved! | ||
|
|
||
| Explore the landscape and see how you can contribute to this evolving space. Whether through contributions, partnerships, or feedback, your involvement can help shape the future of JSON Schema. | ||
|
|
||
| ## Connect with the JSON Schema Community | ||
|
|
||
| <p align="left"> | ||
| <a href="https://json-schema.org/slack" target="blank" style="margin-right: 5px;"><img align="center" src="https://img.icons8.com/color/48/null/slack-new.png" alt="JSON Schema Slack" height="30" width="40" /></a> | ||
| <a href="https://twitter.com/jsonschema" target="blank" style="margin-right: 5px;"><img align="center" src="https://raw.githubusercontent.com/rahuldkjain/github-profile-readme-generator/master/src/images/icons/Social/twitter.svg" alt="JSON Schema Twitter" height="30" width="40" /></a> | ||
| <a href="https://www.linkedin.com/company/jsonschema" target="blank" style="margin-right: 5px;"><img align="center" src="https://raw.githubusercontent.com/rahuldkjain/github-profile-readme-generator/master/src/images/icons/Social/linked-in-alt.svg" alt="JSON Schema LinkedIn" height="30" width="40" /></a> | ||
| <a href="https://www.youtube.com/@JSONSchemaOrgOfficial" target="blank"><img align="center" src="https://raw.githubusercontent.com/rahuldkjain/github-profile-readme-generator/master/src/images/icons/Social/youtube.svg" alt="JSON Schema YouTube" height="30" width="40" /></a> | ||
| </p> |