Merge branch 'json-schema-org:main' into content-schema-keyword

Author: valeriahhdez

.github/workflows/link-checker.yml

@@ -51,7 +51,7 @@ jobs:
       # This will run the link checker on all markdown files in the pages directory      
       - name: Link Checker
         id: lychee
-        uses: lycheeverse/lychee-action@v1
+        uses: lycheeverse/lychee-action@v2
         with:
           args: --base https://json-schema.org  --verbose --no-progress --accept 200,204,429,403  './pages/**/*.md' --cache --max-cache-age 1d  https://json-schema.org 
           token: ${{secrets.GITHUB_TOKEN}}

CONTRIBUTING-docs.md

@@ -0,0 +1,75 @@
+# Docs Contributing Guide
+
+This guide describes the workflow to contribute to the JSON Schema technical documentation. If you would like to contribute to other aspects of the JSON Schema website, like writing blog articles or publishing a case study, please read the website's [Contributing Guide](https://github.com/json-schema-org/website/blob/main/CONTRIBUTING.md) for more details. 
+
+## Welcome
+Thank you for helping us improve our documentation.
+
+This guide is intended for use by documentation contributors and will help you get started with the basics of our working processes.
+
+## Before you start
+To contribute to the JSON Schema documentation you will need to complete the following steps:
+
+1. [Create a GitHub account](https://docs.github.com/en/get-started/start-your-journey/creating-an-account-on-github), if you don't have one already.
+2. Read our [Code of Conduct](https://json-schema.org/overview/code-of-conduct).
+3. [Install the JSON Schema website](https://github.com/json-schema-org/website/blob/main/INSTALLATION.md) on your computer.
+4. Read our [style guide](https://json-schema.org/md-style-guide). 
+
+## Community engagement
+To stay updated with news about the JSON Schema project and its documentation, engage with our team, ask questions, and discuss ideas, please join our [Slack workspace](https://json-schema.org/slack). We particularly recommend the following channels:
+
+- `#documentation`: Discussions related to the JSON Schema documentation.
+
+- `#website`: Discussions related to our website.
+
+- `#introductions`: Self-introductions and connecting with other members of the community.
+
+- `#community-announcements`: Events and updates related to the JSON Schema project.
+
+- `#anouncements`: Important announcement from the JSON Schema organization.
+
+- `#stack-overflow`: Stack overflow questions tagged with JSON Schema.
+  
+## Best practices
+
+This is a list of best practices the JSON Schema project strives for and resources we recommend for additional information:
+
+1. File and branching naming conventions: We use dashes instead of spaces, and lowercase letters to name .md files and branches. For example: `implementers-guide.md`, `web-feat-diataxis`.
+2. Commit messages: To learn how to write good commit messages, see [Step-by-step guide on how to write good commit messages on Git](https://www.freecodecamp.org/news/how-to-write-better-git-commit-messages/).
+
+## Contribution workflow 
+
+Here we describe three ways you can help us improve our documentation:
+
+
+1. Review pull requests
+2. Work on an existing issue 
+3. Propose changes 
+
+### Review pull requests
+
+Are you new to the JSON Schema community? Help us review pull requests. Reviewing pull requests helps you familiarize yourself with our workflows, learn how others contribute, and understand the project's needs and goals. It's a great way to start contributing and you'll be better prepared to make your own contributions.  
+
+### Work on an existing issue
+
+To work on an existing issue, go to the [JSON Schema docs board](https://github.com/orgs/json-schema-org/projects/16) and check all the open issues.  
+
+If the issue you select has no assignees, you can claim the issue by assigning it to yourself and tag @json-schema-org/docs-team in the comments to let us know you'll be working on it. 
+
+If the issue you select has already an assignee, write a comment expressing your interest in collaborating with them. The JSON Schema respects the order in which people claim issues, therefore, you will have to check if the assignee is accepting collaborations.
+
+After you have been assigned to an issue, fork the [json-schema-org/website](https://github.com/json-schema-org/website) repository and create a new branch from `main` to work on the changes. 
+
+### Propose changes
+
+To propose modifications to our documentation that do not have an issue in the [documentation board](https://github.com/orgs/json-schema-org/projects/16), you can [create a GitHub issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue#creating-an-issue-from-a-repository) and use the *Documentation* template to describe the changes. After that, you can decide whether you want to work on the changes yourself or let someone else claim the issue. If you decide to work on the issue, assign it to yourself and commit the changes to a new branch. 
+
+## Create a Pull Request
+
+To submit your work to review by the community, open a draft pull request to the `main` upstream branch, and add the issue your pull request solves. Add @json-schema-org/docs-team as a reviewer of your pull request, and let us know in the #documentation Slack channel your pull request is ready for review. 
+
+The reviewers might ask for additional changes. When they approve your pull request, you can merge your changes into `main` and your contribution to the project will be complete!
+
+<br>
+
+We created this guide based on templates from [The Good Docs Project](https://www.thegooddocsproject.dev/).

CONTRIBUTING.md

@@ -6,7 +6,7 @@ All types of contributions are encouraged and valued. See the [Table of Contents
 
 If you don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation:
 - Star the project on Github
-- Post on Twitter or Linkedin about JSON Schema `#jsonschema
+- Post on X or Linkedin about JSON Schema `#jsonschema
 
 ## Table of Contents
 
@@ -61,7 +61,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. 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).
+Want to help us improve the JSON Schema documentation? Check out our [docs Contributing guide](https://github.com/json-schema-org/website/blob/main/CONTRIBUTING-docs.md) for docs and Style guide. These documents will give you the basics of our processes to get you started and text-formatting guidelines to create consistent documentation for JSON Schema. 
 
 ### 🌐 Improving the Website
 

INSTALLATION.md

@@ -49,6 +49,8 @@ git submodule update
 
 ### Setting Up Environment Variables
 
+This step is optional. Environment variables are not required to run the website on your local development server.
+
 1. Create a new `.env` file by copying the contents of the `.env.example` into `.env` file. Use this command:
 ```
 cp .env.example .env

README.md

@@ -89,7 +89,7 @@ Thanks goes to these wonderful people who contributed to this website:
 
 <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://x.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>

_includes/community

@@ -345,11 +345,10 @@ const Footer = () => (
         </div>
         <div className=''>
           <a
-            href='https://twitter.com/jsonschema'
+            href='https://x.com/jsonschema'
             className='flex items-center text-white'
           >
-            <img src='/img/logos/x-twitter.svg' className='w-4 h-4 mr-2' />
-            Twitter
+            <img src='/img/logos/x-twitter.svg' className='w-4 h-4 mr-2' />X
           </a>
         </div>
         <div className=''>

components/Layout.tsx

@@ -109,6 +109,7 @@ const getDocsPath = [
   '/overview/use-cases',
   '/overview/code-of-conduct',
   '/overview/faq',
+  '/overview/roadmap',
 ];
 const getStartedPath = [
   '/learn',
@@ -362,6 +363,7 @@ export const DocsNav = ({
             label='What is JSON Schema?'
             setOpen={setOpen}
           />
+          <DocLink uri='/overview/roadmap' label='Roadmap' setOpen={setOpen} />
           <DocLink
             uri='/overview/sponsors'
             label='Sponsors'

components/Sidebar.tsx

@@ -19,6 +19,7 @@ export const SectionContext = React.createContext<
   | 'overview'
   | 'getting-started'
   | 'reference'
+  | 'roadmap'
 >(null);
 export const BlockContext = React.createContext<BlockContextValue | null>(null);
 export const FullMarkdownContext = React.createContext<string | null>(null);

context.ts

@@ -2,7 +2,7 @@
   {
     "title": "How JSON Schema Was an Obvious Choice at GitHub",
     "summary": "At GitHub's Docs Engineering team, while shipping releases to production 20 times per day or more, JSON Schema is critical in increasing confidence in changes to data, content and APIs.",
-    "logo": "/img/logos/github-logo.png",
+    "logo": "/img/logos/github-logo.svg",
     "links": {
       "lang": "URL1",
       "url": "/blog/posts/github-case-study"