From 6dd9ed4abed139e1402b4331c2847419a219fbf2 Mon Sep 17 00:00:00 2001 From: Adi-204 Date: Mon, 23 Dec 2024 16:06:35 +0530 Subject: [PATCH 1/8] Update on Dockerfile Implementation for Windows Users --- Dockerfile | 1 + INSTALLATION.md | 80 +++++++++++++++++++++++++++++++++---------------- 2 files changed, 55 insertions(+), 26 deletions(-) diff --git a/Dockerfile b/Dockerfile index ed9ac7892..d3a2d8055 100644 --- a/Dockerfile +++ b/Dockerfile @@ -5,6 +5,7 @@ WORKDIR /app COPY package*.json ./ RUN apk add --update git && \ + corepack enable && \ git init && \ git submodule init && \ git submodule update && \ diff --git a/INSTALLATION.md b/INSTALLATION.md index be3b2cb03..5c2aadb01 100644 --- a/INSTALLATION.md +++ b/INSTALLATION.md @@ -4,31 +4,41 @@ This guide provides step-by-step instructions for installing the JSON Schema Web ## Table of Contents -1. [Setting Up the Project](#setting-up-the-project) - - [Requirements](#requirements) - - [Cloning the Repository](#cloning-the-repository) - - [Setting Up Environment Variables](#setting-up-environment-variables) -2. [Corepack Configuration](#corepack-configuration) - - [What is Corepack?](#what-is-corepack) - - [Installing Corepack](#installing-corepack) - - [Using Corepack with This Project](#using-corepack-with-this-project) - - [Updating Yarn Version](#updating-yarn-version) - - [Troubleshooting](#troubleshooting) -3. [Post-Configuration Steps](#post-configuration-steps) - - [Installing Dependencies](#installing-dependencies) - - [Running the Development Server](#running-the-development-server) - - [Building Static Files](#building-static-files) -4. [Testing](#testing) - - [Running Tests](#running-tests) - - [Test Coverage](#test-coverage) - - [Writing Tests](#writing-tests) -5. [Code Quality](#code-quality) - - [Formatting](#formatting) - - [Linting](#linting) - - [Husky for Git Hooks](#husky-for-git-hooks) -6. [Run locally using Docker](#docker-deployment) - - [Prerequisites](#prerequisites) - - [Steps](#steps) +- [JSON Schema Website: Installation and Development Guide](#json-schema-website-installation-and-development-guide) + - [Table of Contents](#table-of-contents) + - [Setting up Project](#setting-up-project) + - [Configuration](#configuration) + - [Requirements](#requirements) + - [Cloning the repository](#cloning-the-repository) + - [Setting Up Environment Variables](#setting-up-environment-variables) + - [Corepack Configuration](#corepack-configuration) + - [What is Corepack?](#what-is-corepack) + - [Installing Corepack](#installing-corepack) + - [Using Corepack with This Project](#using-corepack-with-this-project) + - [Updating Yarn Version](#updating-yarn-version) + - [Troubleshooting](#troubleshooting) + - [Post-Configuration Steps](#post-configuration-steps) + - [Installing Dependencies](#installing-dependencies) + - [Running the Development Server](#running-the-development-server) + - [Building Static Files](#building-static-files) + - [Testing](#testing) + - [Running Tests](#running-tests) + - [Opening Cypress Test Runner](#opening-cypress-test-runner) + - [Running All Tests Headlessly](#running-all-tests-headlessly) + - [Test Coverage](#test-coverage) + - [E2E Test Coverage](#e2e-test-coverage) + - [Component Test Coverage](#component-test-coverage) + - [Full Test Coverage](#full-test-coverage) + - [Writing Tests](#writing-tests) + - [Code Quality](#code-quality) + - [Formatting](#formatting) + - [Linting](#linting) + - [Husky for git hooks](#husky-for-git-hooks) + - [pre-commit hook](#pre-commit-hook) + - [Run locally using Docker](#run-locally-using-docker) + - [Prerequisites:](#prerequisites) + - [Windows Users Steps:](#windows-users-steps) + - [Mac/Linux Users Steps:](#maclinux-users-steps) ## Setting up Project @@ -274,7 +284,25 @@ If you are a Docker lover, you have the option to use it following these instruc After cloning repository to your local, perform the following steps from the root of the repository. -#### Steps: +#### Windows Users Steps: +1. Build the Docker image: + ```bash + docker build -t app . + ``` + +2. Install dependencies inside the container: + ```bash + docker run --rm -it -v "${PWD}:/app" app sh -c "yarn install" + ``` + +3. Start the container: + ```bash + docker run --rm -it -v "${PWD}:/app" -p 3000:3000 app + ``` + +Note: ${PWD} refers to the current working directory on your system. This ensures that your local project folder is mounted to the /app directory inside the container. + +#### Mac/Linux Users Steps: 1. Build the Docker image: ```bash make install From 2e769f0d2cc3f61a3081f63d53284bd73455cc24 Mon Sep 17 00:00:00 2001 From: Adi-204 Date: Thu, 26 Dec 2024 15:42:00 +0530 Subject: [PATCH 2/8] Revert "Update on Dockerfile Implementation for Windows Users" This reverts commit 6dd9ed4abed139e1402b4331c2847419a219fbf2. --- Dockerfile | 1 - INSTALLATION.md | 80 ++++++++++++++++--------------------------------- 2 files changed, 26 insertions(+), 55 deletions(-) diff --git a/Dockerfile b/Dockerfile index d3a2d8055..ed9ac7892 100644 --- a/Dockerfile +++ b/Dockerfile @@ -5,7 +5,6 @@ WORKDIR /app COPY package*.json ./ RUN apk add --update git && \ - corepack enable && \ git init && \ git submodule init && \ git submodule update && \ diff --git a/INSTALLATION.md b/INSTALLATION.md index 5c2aadb01..be3b2cb03 100644 --- a/INSTALLATION.md +++ b/INSTALLATION.md @@ -4,41 +4,31 @@ This guide provides step-by-step instructions for installing the JSON Schema Web ## Table of Contents -- [JSON Schema Website: Installation and Development Guide](#json-schema-website-installation-and-development-guide) - - [Table of Contents](#table-of-contents) - - [Setting up Project](#setting-up-project) - - [Configuration](#configuration) - - [Requirements](#requirements) - - [Cloning the repository](#cloning-the-repository) - - [Setting Up Environment Variables](#setting-up-environment-variables) - - [Corepack Configuration](#corepack-configuration) - - [What is Corepack?](#what-is-corepack) - - [Installing Corepack](#installing-corepack) - - [Using Corepack with This Project](#using-corepack-with-this-project) - - [Updating Yarn Version](#updating-yarn-version) - - [Troubleshooting](#troubleshooting) - - [Post-Configuration Steps](#post-configuration-steps) - - [Installing Dependencies](#installing-dependencies) - - [Running the Development Server](#running-the-development-server) - - [Building Static Files](#building-static-files) - - [Testing](#testing) - - [Running Tests](#running-tests) - - [Opening Cypress Test Runner](#opening-cypress-test-runner) - - [Running All Tests Headlessly](#running-all-tests-headlessly) - - [Test Coverage](#test-coverage) - - [E2E Test Coverage](#e2e-test-coverage) - - [Component Test Coverage](#component-test-coverage) - - [Full Test Coverage](#full-test-coverage) - - [Writing Tests](#writing-tests) - - [Code Quality](#code-quality) - - [Formatting](#formatting) - - [Linting](#linting) - - [Husky for git hooks](#husky-for-git-hooks) - - [pre-commit hook](#pre-commit-hook) - - [Run locally using Docker](#run-locally-using-docker) - - [Prerequisites:](#prerequisites) - - [Windows Users Steps:](#windows-users-steps) - - [Mac/Linux Users Steps:](#maclinux-users-steps) +1. [Setting Up the Project](#setting-up-the-project) + - [Requirements](#requirements) + - [Cloning the Repository](#cloning-the-repository) + - [Setting Up Environment Variables](#setting-up-environment-variables) +2. [Corepack Configuration](#corepack-configuration) + - [What is Corepack?](#what-is-corepack) + - [Installing Corepack](#installing-corepack) + - [Using Corepack with This Project](#using-corepack-with-this-project) + - [Updating Yarn Version](#updating-yarn-version) + - [Troubleshooting](#troubleshooting) +3. [Post-Configuration Steps](#post-configuration-steps) + - [Installing Dependencies](#installing-dependencies) + - [Running the Development Server](#running-the-development-server) + - [Building Static Files](#building-static-files) +4. [Testing](#testing) + - [Running Tests](#running-tests) + - [Test Coverage](#test-coverage) + - [Writing Tests](#writing-tests) +5. [Code Quality](#code-quality) + - [Formatting](#formatting) + - [Linting](#linting) + - [Husky for Git Hooks](#husky-for-git-hooks) +6. [Run locally using Docker](#docker-deployment) + - [Prerequisites](#prerequisites) + - [Steps](#steps) ## Setting up Project @@ -284,25 +274,7 @@ If you are a Docker lover, you have the option to use it following these instruc After cloning repository to your local, perform the following steps from the root of the repository. -#### Windows Users Steps: -1. Build the Docker image: - ```bash - docker build -t app . - ``` - -2. Install dependencies inside the container: - ```bash - docker run --rm -it -v "${PWD}:/app" app sh -c "yarn install" - ``` - -3. Start the container: - ```bash - docker run --rm -it -v "${PWD}:/app" -p 3000:3000 app - ``` - -Note: ${PWD} refers to the current working directory on your system. This ensures that your local project folder is mounted to the /app directory inside the container. - -#### Mac/Linux Users Steps: +#### Steps: 1. Build the Docker image: ```bash make install From c4c6a9a542fdec939666bd6fabf332cc86bea977 Mon Sep 17 00:00:00 2001 From: Adi-204 Date: Fri, 27 Dec 2024 14:16:37 +0530 Subject: [PATCH 3/8] Add protoc-gen-jsonschema --- data/tooling-data.yaml | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/data/tooling-data.yaml b/data/tooling-data.yaml index 17449638b..710113da9 100644 --- a/data/tooling-data.yaml +++ b/data/tooling-data.yaml @@ -3034,3 +3034,16 @@ source: 'https://github.com/andreineculau/json-schema-random' license: 'Apache-2.0' status: 'obsolete' + +- name: protoc-gen-jsonschema + description: 'JsonSchema generator plugin for Google Protocol Buffers' + toolingTypes: ['model-to-schema'] + languages: ['Protocol Buffers'] + maintainers: + - name: 'Uanid' + username: 'uanid' + platform: 'github' + license: 'Apache-2.0' + source: 'https://github.com/pubg/protoc-gen-jsonschema' + supportedDialects: + draft: ['4', '6', '7', '2019-09', '2020-12'] \ No newline at end of file From ab500e8445f78dcaee72260c251b91df60d05767 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 27 Dec 2024 10:14:15 +0100 Subject: [PATCH 4/8] chore(deps): bump slate from 0.110.2 to 0.112.0 (#1203) Bumps [slate](https://github.com/ianstormtaylor/slate) from 0.110.2 to 0.112.0. - [Release notes](https://github.com/ianstormtaylor/slate/releases) - [Commits](https://github.com/ianstormtaylor/slate/compare/slate@0.110.2...slate@0.112.0) --- updated-dependencies: - dependency-name: slate dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package.json | 2 +- yarn.lock | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/package.json b/package.json index 907665250..e1de179bb 100644 --- a/package.json +++ b/package.json @@ -49,7 +49,7 @@ "react-syntax-highlighter": "^15.6.1", "react-text-truncate": "^0.19.0", "reading-time": "^1.5.0", - "slate": "^0.110.2", + "slate": "^0.112.0", "slate-react": "^0.108.0", "slugify": "^1.6.5", "yarn": "1.22.22", diff --git a/yarn.lock b/yarn.lock index 73ad621c7..799b44764 100644 --- a/yarn.lock +++ b/yarn.lock @@ -8345,7 +8345,7 @@ __metadata: react-syntax-highlighter: "npm:^15.6.1" react-text-truncate: "npm:^0.19.0" reading-time: "npm:^1.5.0" - slate: "npm:^0.110.2" + slate: "npm:^0.112.0" slate-react: "npm:^0.108.0" slugify: "npm:^1.6.5" tailwindcss: "npm:^3.3.5" @@ -10732,14 +10732,14 @@ __metadata: languageName: node linkType: hard -"slate@npm:^0.110.2": - version: 0.110.2 - resolution: "slate@npm:0.110.2" +"slate@npm:^0.112.0": + version: 0.112.0 + resolution: "slate@npm:0.112.0" dependencies: immer: "npm:^10.0.3" is-plain-object: "npm:^5.0.0" tiny-warning: "npm:^1.0.3" - checksum: 10c0/90ed1b3c92898ccd4b3cb33216797acfb6eacbc2e60c7b8d8af4f02305195c3832a8cddb4651b10c4beb1da122bfaa42bb748e6464d75c8bfd545f017297041c + checksum: 10c0/e31dc1eb13c20505d243398bb91efeb8a8ef602eef6c8d4b55f616a39dd80ba4405916a4e40f30b0aa4ba8fbfd52a83508ecb947ad4b4cbc68d8e1f6b518eb96 languageName: node linkType: hard From 11a66eeded50218d0dca4c10a48779a34138ef2b Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 27 Dec 2024 10:15:10 +0100 Subject: [PATCH 5/8] chore(deps): bump codecov/codecov-action from 5.1.1 to 5.1.2 (#1198) Bumps [codecov/codecov-action](https://github.com/codecov/codecov-action) from 5.1.1 to 5.1.2. - [Release notes](https://github.com/codecov/codecov-action/releases) - [Changelog](https://github.com/codecov/codecov-action/blob/main/CHANGELOG.md) - [Commits](https://github.com/codecov/codecov-action/compare/v5.1.1...v5.1.2) --- updated-dependencies: - dependency-name: codecov/codecov-action dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 3f2e8a656..6c9d90e03 100644 --- 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.1.1 + uses: codecov/codecov-action@v5.1.2 with: token: ${{ secrets.CODECOV_TOKEN }} name: ${{ env.CODECOV_UNIQUE_NAME }} From f3cb1b83b86c530fcb181d318949caf81e987af5 Mon Sep 17 00:00:00 2001 From: Manish chaudhary <125847751+techmannih@users.noreply.github.com> Date: Fri, 27 Dec 2024 14:55:10 +0530 Subject: [PATCH 6/8] improve Specification page design (#1207) * improve Specification table design * fix lint error * replace blue-600 to primary color --- components/DocTable.tsx | 53 ++++++++++++++++++++++------------------- 1 file changed, 28 insertions(+), 25 deletions(-) diff --git a/components/DocTable.tsx b/components/DocTable.tsx index 770a660ca..8b668261a 100644 --- a/components/DocTable.tsx +++ b/components/DocTable.tsx @@ -4,50 +4,53 @@ import Link from 'next/link'; const DocTable = ({ frontmatter }: any) => { return ( <> -
- +
+
+
Specification Details
+
+
- - + - - - - + + - - + - - -
- Specification +
+ Specification + - {' '} {frontmatter.Specification}
- Published - - {frontmatter.Published} +
+ Published {frontmatter.Published}
- Authors +
+ Authors - {frontmatter.authors.map((author: string, index: number) => { - return
{author}
; - })} + 		+ {frontmatter.authors.map((author: string, index: number) => ( + + {author} + {index < frontmatter.authors.length - 1 ? ', ' : ''} + + ))}
- Metaschema + + Metaschema + {frontmatter.Metaschema} From 7e80c149e646272f554a26687cb06dca7853fbef Mon Sep 17 00:00:00 2001 From: Gabriel Souki Hernandez Date: Fri, 27 Dec 2024 05:52:21 -0400 Subject: [PATCH 7/8] Update conventions.md (#1107) Removed a duplicated text --- pages/understanding-json-schema/conventions.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/pages/understanding-json-schema/conventions.md b/pages/understanding-json-schema/conventions.md index e6b2e8fc3..7979db58c 100644 --- a/pages/understanding-json-schema/conventions.md +++ b/pages/understanding-json-schema/conventions.md @@ -70,9 +70,6 @@ isn\'t valid. > These examples are tested automatically whenever the book is built, so hopefully they are not just helpful, but also correct! -These examples are tested automatically whenever the book is built, so -hopefully they are not just helpful, but also correct! - For example, here\'s a snippet illustrating how to use the `number` type: ```json From 5114356e866007739acb58d2f4140ba30ee26b05 Mon Sep 17 00:00:00 2001 From: Ronak Surana <100184606+RonakSurana-2001@users.noreply.github.com> Date: Fri, 27 Dec 2024 15:29:05 +0530 Subject: [PATCH 8/8] Add next prev button in Docs-->Overview (#1084) * Added Next Prev Button in docs/Overview * Changed local host to public hosted URL * Made Changes for Build * Made Changes to the Overview * Added Navigation in Docs/ Getting Started * Added NavButton in learn * Correct NavButtons Build Error --- components/NavigationButtons.tsx | 93 +++++++++++++++++++ components/NextPrevButton.tsx | 81 ---------------- components/StyledMarkdown.tsx | 4 +- pages/learn/[slug].page.tsx | 7 ++ pages/learn/file-system.md | 6 ++ pages/learn/json-schema-examples.md | 6 ++ pages/learn/miscellaneous-examples.md | 3 + pages/overview/[slug].page.tsx | 7 ++ pages/overview/case-studies/index.page.tsx | 7 ++ pages/overview/code-of-conduct/index.page.tsx | 15 ++- pages/overview/faq/index.page.tsx | 8 ++ pages/overview/roadmap/index.page.tsx | 7 ++ pages/overview/similar-technologies.md | 6 ++ pages/overview/sponsors/index.page.tsx | 7 ++ pages/overview/use-cases/index.page.tsx | 17 +++- pages/overview/what-is-jsonschema.md | 3 + 16 files changed, 188 insertions(+), 89 deletions(-) create mode 100644 components/NavigationButtons.tsx delete mode 100644 components/NextPrevButton.tsx diff --git a/components/NavigationButtons.tsx b/components/NavigationButtons.tsx new file mode 100644 index 000000000..8e8747577 --- /dev/null +++ b/components/NavigationButtons.tsx @@ -0,0 +1,93 @@ +import Image from 'next/image'; +import React from 'react'; +import Link from 'next/link'; + +/* +To use this component: +1) Add prev and next metadata to the markdown page following this format: + +--- +title: Creating your first schema +section: docs +prev: + label: prev + url: '#1' +next: + label: Miscellaneous examples + url: '#2' +--- + +2) Add the component to the typescript page: + +import NextPrevButton from '~/components/NextPrevButton'; + +3) Add the component to the body of the page: + + +*/ + +export default function NextPrevButton({ + prevLabel, + prevURL, + nextLabel, + nextURL, +}: any) { + return ( +
+ {prevURL && prevLabel ? ( +
+
+ +
+ prev icon +
+ Go Back +
+
+
+ {prevLabel} +
+ +
+
+ ) : ( +
+ )} + + {nextURL && nextLabel ? ( +
+
+ +
+ next icon +
+ Up Next +
+
+
+ {nextLabel} +
+ +
+
+ ) : ( +
+ )} +
+ ); +} diff --git a/components/NextPrevButton.tsx b/components/NextPrevButton.tsx deleted file mode 100644 index 6c88b641c..000000000 --- a/components/NextPrevButton.tsx +++ /dev/null @@ -1,81 +0,0 @@ -import Image from 'next/image'; -import React from 'react'; -import Link from 'next/link'; - -/* -To use this component: -1) Add prev and next metadata to the markdown page following this format: - ---- -title: Creating your first schema -section: docs -prev: - label: prev - url: '#1' -next: - label: Miscellaneous examples - url: '#2' ---- - -2) Add the component to the typescript page: - -import NextPrevButton from '~/components/NextPrevButton'; - -3) Add the component to the body of the page: - - -*/ - -export default function NextPrevButton({ - prevLabel, - prevURL, - nextLabel, - nextURL, -}: any) { - return ( -
-
-
- -
- prev icon -
Go Back
-
-
- {prevLabel} -
- -
-
- -
-
- -
- next icon -
Up Next
-
-
- {nextLabel} -
- -
-
-
- ); -} diff --git a/components/StyledMarkdown.tsx b/components/StyledMarkdown.tsx index e856d5010..53f771545 100644 --- a/components/StyledMarkdown.tsx +++ b/components/StyledMarkdown.tsx @@ -519,8 +519,8 @@ const StyledMarkdownBlock = ({ markdown }: { markdown: string }) => {
menu-icon diff --git a/pages/learn/[slug].page.tsx b/pages/learn/[slug].page.tsx index f110ff75d..7065699f3 100644 --- a/pages/learn/[slug].page.tsx +++ b/pages/learn/[slug].page.tsx @@ -7,6 +7,7 @@ import getStaticMarkdownProps from '~/lib/getStaticMarkdownProps'; import { Headline1 } from '~/components/Headlines'; import { SectionContext } from '~/context'; import { DocsHelp } from '~/components/DocsHelp'; +import NextPrevButton from '~/components/NavigationButtons'; export async function getStaticPaths() { return getStaticMarkdownPaths('pages/learn'); @@ -31,6 +32,12 @@ export default function StaticMarkdownPage({ {frontmatter.title} + ); diff --git a/pages/learn/file-system.md b/pages/learn/file-system.md index a408b70b1..f6ae14331 100644 --- a/pages/learn/file-system.md +++ b/pages/learn/file-system.md @@ -1,6 +1,12 @@ --- section: docs title: Modeling a file system with JSON Schema +prev: + label: Miscellaneous examples + url: /learn/miscellaneous-examples +next: + label: Other examples + url: /learn/json-schema-examples --- In this step-by-step guide you will learn how to design a JSON Schema that mirrors the structure of an `/etc/fstab` file. diff --git a/pages/learn/json-schema-examples.md b/pages/learn/json-schema-examples.md index d86b9656b..c91259267 100644 --- a/pages/learn/json-schema-examples.md +++ b/pages/learn/json-schema-examples.md @@ -1,6 +1,12 @@ --- section: docs title: JSON Schema examples +prev: + label: Modeling a file system + url: /learn/file-system +next: + label: Miscellaneous examples + url: /learn/miscellaneous-examples --- In this page, you will find examples illustrating different use cases to help you get the most out of your JSON Schemas. These examples cover a wide range of scenarios, and each example comes with accompanying JSON data and explanation, showcasing how JSON Schemas can be applied to various domains. You can modify these examples to suit your specific needs, as this is just one of the many ways you can utilize JSON Schemas. diff --git a/pages/learn/miscellaneous-examples.md b/pages/learn/miscellaneous-examples.md index ba63f03b1..d943e77b7 100644 --- a/pages/learn/miscellaneous-examples.md +++ b/pages/learn/miscellaneous-examples.md @@ -1,6 +1,9 @@ --- section: docs title: Miscellaneous Examples +next: + label: Modelling a file system + url: /learn/file-system --- In this page, you will find miscellaneous examples illustrating different uses cases to help you get the most out of your JSON Schemas. Each example comes with accompanying JSON data and explanation. diff --git a/pages/overview/[slug].page.tsx b/pages/overview/[slug].page.tsx index e4d5476d7..72db35309 100644 --- a/pages/overview/[slug].page.tsx +++ b/pages/overview/[slug].page.tsx @@ -7,6 +7,7 @@ import getStaticMarkdownProps from '~/lib/getStaticMarkdownProps'; import { Headline1 } from '~/components/Headlines'; import { SectionContext } from '~/context'; import { DocsHelp } from '~/components/DocsHelp'; +import NextPrevButton from '~/components/NavigationButtons'; export async function getStaticPaths() { return getStaticMarkdownPaths('pages/overview'); @@ -32,6 +33,12 @@ export default function StaticMarkdownPage({ {frontmatter.title} + ); diff --git a/pages/overview/case-studies/index.page.tsx b/pages/overview/case-studies/index.page.tsx index 81c761ca6..b79b1352d 100644 --- a/pages/overview/case-studies/index.page.tsx +++ b/pages/overview/case-studies/index.page.tsx @@ -7,6 +7,7 @@ import data from 'data/case-studies.json'; import Card from '~/components/Card'; import { DocsHelp } from '~/components/DocsHelp'; import { useTheme } from 'next-themes'; +import NextPrevButton from '~/components/NavigationButtons'; export default function ContentExample() { const newTitle = 'Case Studies'; @@ -47,6 +48,12 @@ export default function ContentExample() { /> ))}
+ ); diff --git a/pages/overview/code-of-conduct/index.page.tsx b/pages/overview/code-of-conduct/index.page.tsx index c4d74033e..f4ebff025 100644 --- a/pages/overview/code-of-conduct/index.page.tsx +++ b/pages/overview/code-of-conduct/index.page.tsx @@ -6,6 +6,7 @@ import matter from 'gray-matter'; import StyledMarkdown from '~/components/StyledMarkdown'; import { SectionContext } from '~/context'; import { DocsHelp } from '~/components/DocsHelp'; +import NextPrevButton from '~/components/NavigationButtons'; export async function getStaticProps() { const block = fs.readFileSync( @@ -20,7 +21,13 @@ export async function getStaticProps() { }; } -export default function Content({ blocks }: { blocks: any[] }) { +export default function Content({ + blocks, +}: { + blocks: any[]; + frontmatter: any; + content: any; +}) { const newTitle = 'Code of Conduct'; return ( @@ -29,6 +36,12 @@ export default function Content({ blocks }: { blocks: any[] }) { {newTitle} + ); diff --git a/pages/overview/faq/index.page.tsx b/pages/overview/faq/index.page.tsx index 283edf29e..b47a3f570 100644 --- a/pages/overview/faq/index.page.tsx +++ b/pages/overview/faq/index.page.tsx @@ -5,6 +5,7 @@ import { SectionContext } from '~/context'; import Faq from '~/components/Faq'; import { Headline1 } from '~/components/Headlines'; import { DocsHelp } from '~/components/DocsHelp'; +import NextPrevButton from '~/components/NavigationButtons'; export default function Content() { const newTitle = 'FAQ'; @@ -20,7 +21,14 @@ export default function Content() { Below you'll find answers to questions we get asked the most about JSON Schema.

+ + ); diff --git a/pages/overview/roadmap/index.page.tsx b/pages/overview/roadmap/index.page.tsx index 8f3c0d92a..ed360f9af 100644 --- a/pages/overview/roadmap/index.page.tsx +++ b/pages/overview/roadmap/index.page.tsx @@ -5,6 +5,7 @@ import Head from 'next/head'; import { Headline1 } from '~/components/Headlines'; import { SectionContext } from '~/context'; import roadmap from '~/data/roadmap.json'; +import NextPrevButton from '~/components/NavigationButtons'; const statusColors = { 'In Progress': 'bg-green-600 text-white dark:bg-green-500', @@ -130,6 +131,12 @@ export default function Roadmap() { + ); diff --git a/pages/overview/similar-technologies.md b/pages/overview/similar-technologies.md index c4693704f..7867a54e5 100644 --- a/pages/overview/similar-technologies.md +++ b/pages/overview/similar-technologies.md @@ -1,6 +1,12 @@ --- section: docs title: Similar Technologies +prev: + label: FAQs + url: '/overview/faq' +next: + label: Code of Conduct + url: '/overview/code-of-conduct' --- While we think that JSON Schema has a unique value proposition, we'd like to provide visibility to other technologies that share similar goals: diff --git a/pages/overview/sponsors/index.page.tsx b/pages/overview/sponsors/index.page.tsx index a26f1dfe7..a3ab3dba9 100644 --- a/pages/overview/sponsors/index.page.tsx +++ b/pages/overview/sponsors/index.page.tsx @@ -7,6 +7,7 @@ import matter from 'gray-matter'; import StyledMarkdown from '~/components/StyledMarkdown'; import { SectionContext } from '~/context'; import { DocsHelp } from '~/components/DocsHelp'; +import NextPrevButton from '~/components/NavigationButtons'; export async function getStaticProps() { const block1 = fs.readFileSync('pages/overview/sponsors/_index.md', 'utf-8'); @@ -28,6 +29,12 @@ export default function ContentExample({ blocks }: { blocks: any[] }) { {newTitle} + ); diff --git a/pages/overview/use-cases/index.page.tsx b/pages/overview/use-cases/index.page.tsx index 6e2811a51..1c77df4cc 100644 --- a/pages/overview/use-cases/index.page.tsx +++ b/pages/overview/use-cases/index.page.tsx @@ -6,6 +6,7 @@ import { Headline1 } from '~/components/Headlines'; import Card from '~/components/Card'; import data from '~/data/use-cases.json'; import { DocsHelp } from '~/components/DocsHelp'; +import NextPrevButton from '~/components/NavigationButtons'; export default function Content() { const newTitle = 'Use Cases'; @@ -19,8 +20,8 @@ export default function Content() { {newTitle}

Discover everything you can do with JSON Schema. This section presents - the most common use cases for JSON Schema, but but there may be many - more applications waiting to be discovered. + the most common use cases for JSON Schema, but there may be many more + applications waiting to be discovered.

{data.map((element, index) => ( @@ -29,12 +30,18 @@ export default function Content() { title={element.title} body={element.summary} icon='/icons/bulb2.svg' - headerSize={'medium'} - extended={true} - bodyTextSize={'small'} + headerSize='medium' + extended + bodyTextSize='small' /> ))}
+ ); diff --git a/pages/overview/what-is-jsonschema.md b/pages/overview/what-is-jsonschema.md index 4c1ccc826..b5c48c16e 100644 --- a/pages/overview/what-is-jsonschema.md +++ b/pages/overview/what-is-jsonschema.md @@ -1,6 +1,9 @@ --- section: docs title: What is JSON Schema? +next: + label: Roadmap + url: '/overview/roadmap' --- > JSON Schema is a declarative language for defining structure and constraints for JSON data.