Merge branch 'main' into benjagm-fix-notes-d6

json-schema-org · Dec 22, 2024 · eb4c9bf · eb4c9bf
2 parents 9667c19 + 8676fc2
commit eb4c9bf
Show file tree

Hide file tree

Showing 60 changed files with 1,762 additions and 1,020 deletions.
diff --git a/.github/workflows/build-preview.yml b/.github/workflows/build-preview.yml
@@ -35,16 +35,6 @@ jobs:
           restore-keys: |
               ${{ runner.os }}-yarn-
       
-      - name: Cache Next Build
-        uses: actions/cache@v4
-        with:
-          path: |
-              ${{ steps.yarn-cache-dir-path.outputs.dir }}
-              ${{ github.workspace }}/.next/cache
-          key: ${{ runner.os }}-nextjs-${{ hashFiles('**/yarn.lock') }}-${{ hashFiles('**/*.js', '**/*.jsx', '**/*.ts', '**/*.tsx') }}
-          restore-keys: |
-              ${{ runner.os }}-nextjs-${{ hashFiles('**/yarn.lock') }}-
-          
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -64,7 +64,7 @@ jobs:
         run: yarn run test:coverage:all
 
       - name: Upload coverage report to Codecov
-        uses: codecov/codecov-action@v5.0.2
+        uses: codecov/codecov-action@v5.1.1
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           name: ${{ env.CODECOV_UNIQUE_NAME }}

diff --git a/.github/workflows/issue.yml b/.github/workflows/issue.yml
@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Auto Label Issue
-        uses: Renato66/[email protected].0
+        uses: Renato66/[email protected].1
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
           ignore-comments: true

diff --git a/.github/workflows/production-deployment.yml b/.github/workflows/production-deployment.yml
@@ -26,16 +26,6 @@ jobs:
               id: yarn-cache-dir-path
               run: echo "dir=$(yarn config get cacheFolder)" >> $GITHUB_OUTPUT
 
-            - name: Cache Next Build
-              uses: actions/cache@v4
-              with:
-                path: |
-                    ${{ steps.yarn-cache-dir-path.outputs.dir }}
-                    ${{ github.workspace }}/.next/cache
-                key: ${{ runner.os }}-nextjs-${{ hashFiles('**/yarn.lock') }}-${{ hashFiles('**/*.js', '**/*.jsx', '**/*.ts', '**/*.tsx') }}
-                restore-keys: |
-                    ${{ runner.os }}-nextjs-${{ hashFiles('**/yarn.lock') }}-
-                
             - name: Setup Node.js
               uses: actions/setup-node@v4
               with:

diff --git a/CONTRIBUTING-docs.md b/CONTRIBUTING-docs.md
@@ -64,6 +64,22 @@ After you have been assigned to an issue, fork the [json-schema-org/website](htt
 
 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. 
 
+## Add metadata to newly created markdown files
+Metadata helps organize content and maintain consistency across all pages in the documentation. It also provides key information about the file, such as its title, author, and the last updated date.
+
+When contributing to the documentation, it is essential to include metadata in every new markdown file. Metadata is critical for successfully building and rendering the file locally. Without it, the file may fail to render correctly or cause errors in the documentation system.
+
+### Example of metadata in a new markdown file
+Every new `.md` file should start with a YAML front matter block. Here's an example:
+---
+    title: "Your Page Title"
+    section: "docs"  # Can be used to categorize the content
+    date: "YYYY-MM-DD"  # Optional: Date when the page was created or last updated
+    author: "Your Name"  # Optional: Your name if you're the author
+    tags: ["tag1", "tag2"]  # Optional: Tags to categorize the page
+---
+To add the front matter metadata, copy and paste the example above at the top of your .md file and replace the details with the information of your document.
+
 ## 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. 

diff --git a/README.md b/README.md
@@ -20,15 +20,15 @@
 </p>
 
 # 👋 Welcome to the JSON Schema website
-This repository contains the sources of JSON Schema website:
+This repository contains the source code of the JSON Schema website:
 
-* It's powered by Next.js,
-* It uses Tailwind CSS framework,
-* It's build and deployed with Netlify.
+* Powered by Next.js,
+* Uses the Tailwind CSS framework,
+* Built and deployed with Netlify.
 
-## Setting up Project
+## Setting up the Project
 
-Please refer to the [INSTALLATION.md](./INSTALLATION.md) file for instructions on how to set up the project on your local machine.
+Please refer to [INSTALLATION.md](./INSTALLATION.md) for instructions on how to set up the project for local development.
 
 ## Project structure
 
@@ -37,41 +37,42 @@ This repository has the following structure:
 <!-- If you make any changes in the project structure, remember to update it. -->
 
 ```text
-  ├── .github                     # Definitions of GitHub workflows, pull request and issue templates
+  ├── .github                     # Definitions of GitHub workflows, pull request, and issue templates
   ├── components                  # Various generic components such as "Button", "Figure", etc.
-  ├── data                        # JSON Schema Implementations.
+  ├── data                        # JSON Schema implementations
   ├── styles                      # Various CSS files
-  ├── lib                         # Various JS code for preparing static data to render in pages
-  ├── pages                       # Website's pages source. It includes raw markdown files and React page templates.
+  ├── lib                         # Various JS code for preparing static data to render on pages
+  ├── pages                       # Website's pages source, including raw markdown files and React page templates
   │    ├── overview               # JSON Schema initiative docs
   │    ├── blog                   # Blog posts
   │    ├── learn                  # JSON Schema docs
   │    └── implementations        # Various pages to describe tools
-  ├── public                      # Data for site metadata and static blog such as images
+  ├── public                      # Data for site metadata and static assets such as images
   ├── next.config.js              # Next.js configuration file
 
 ```
 
 ## Contribute
-
 Here are some areas where you can contribute to the website:
-- Blogs posts
-- Case Studies
+
+- Blog posts
+- Case studies
 - Design
-- Documentation
+- Documentation improvements
 - Website enhancements
-- Add a new JSON Schema Implementation
+- Add a new JSON Schema implementation
 - JSON Schema Landscape
 
-To figure out a good first issue to work on, join our Slack workspace and visit the `#contribute` channel. This channel is specifically designed for onboarding and supporting new contributors.
+To identify good first issues to work on, join our Slack workspace and visit the `#contribute` channel. This channel is specifically designed for onboarding and supporting new contributors.
 
 You should also check out our [Contributing guidelines](./CONTRIBUTING.md).
 
 ### Contributors
 
-Thanks goes to these wonderful people who contributed to this website:
-<a href = "https://github.com/json-schema-org/website/graphs/contributors">
-  <img src = "https://contrib.rocks/image?repo=json-schema-org/website"/>
+Thanks to these wonderful people who contributed to this website:
+<br />
+<a href="https://github.com/json-schema-org/website/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=json-schema-org/website"/>
 </a>
 
 <sub>Made with [contributors-img](https://contrib.rocks).</sub>
@@ -83,19 +84,20 @@ Thanks goes to these wonderful people who contributed to this website:
 ### Backers
 
 **Thank you to all our backers!**
+
 [![Backers](https://opencollective.com/json-schema/backers.svg)](https://opencollective.com/json-schema/backers.svg?avatarHeight=90)
 
 ## 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://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>
+  <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="auto" /></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="auto" /></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="auto" /></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="auto" /></a>
 </p>
 
 ## Inspired by
-This document has been inspired by [AsyncAPI website README.md](https://github.com/asyncapi/website/blob/master/README.md).
+This document was inspired by [AsyncAPI website README.md](https://github.com/asyncapi/website/blob/master/README.md).
 
 ## License
-The contents of this repository are [licensed under](./LICENSE) either the BSD 3-clause license *or* the Academic Free License v3.0.
+The contents of this repository are licensed under either the BSD 3-clause license *or* the Academic Free License v3.0. See [LICENSE](./LICENSE).
diff --git a/_includes/community b/_includes/community
diff --git a/components/AmbassadorsBanner.tsx b/components/AmbassadorsBanner.tsx
@@ -0,0 +1,35 @@
+import Link from 'next/link';
+import React from 'react';
+
+const AmbassadorBanner: React.FC = () => {
+  return (
+    <div className='flex justify-center mx-4 sm:mx-6 md:mx-10 my-8 w-full'>
+      <div className='group relative h-auto w-full sm:w-5/6 md:w-4/5 lg:w-2/3 xl:w-1/2 rounded-lg border border-gray-200 bg-white p-6 sm:p-8 shadow-3xl dark:shadow-2xl dark:shadow-slate-900 transition-colors ease-in-out hover:bg-slate-100 dark:bg-slate-800 hover:dark:bg-slate-900/30'>
+        <h3 className='text-xl sm:text-2xl md:text-3xl font-bold mb-4 text-gray-800 dark:text-slate-100 text-center'>
+          Become a JSON Schema Ambassador
+        </h3>
+        <p className='text-sm sm:text-base md:text-lg text-gray-600 dark:text-slate-100 mb-6 text-center'>
+          The JSON Schema Ambassador program is now open for applications! If
+          you're selected, you'll join JSON Schema's mission of helping
+          community members all over the world build the future of JSON Schema.
+        </p>
+        <div className='w-full grid grid-cols-1 sm:grid-cols-2 gap-4 my-4 mx-auto'>
+          <Link
+            href='https://github.com/json-schema-org/community/tree/main/programs/ambassadors#become-an-json-schema-ambassador'
+            className='inline-block px-6 py-3 bg-blue-600 text-white font-semibold text-center rounded hover:bg-blue-700 transition duration-300'
+          >
+            Become Ambassador
+          </Link>
+          <Link
+            href='https://github.com/json-schema-org/community/tree/main/programs/ambassadors'
+            className='inline-block bg-gray-300 text-slate-700 text-center px-6 py-3 rounded-md shadow hover:bg-gray-400 transition'
+          >
+            Learn More
+          </Link>
+        </div>
+      </div>
+    </div>
+  );
+};
+
+export default AmbassadorBanner;
+33 −0		COMMUNITY-MANAGER.md
+2 −2		INFRASTRUCTURE.md
+3 −3		README.md
+37 −1		programs/ambassadors/ambassadors-schema.json
+45 −12		programs/ambassadors/ambassadors.json