New spec page structure- #823

kwennB · 2024-07-25T09:41:58Z

What kind of change does this PR introduce?

Documentation Enhancement

Issue Number:

Closes #___ [📝 Docs]: Implement the Spec restructuring (Docs Website) #791

Screenshots/videos:

Added

Summary

The Specification section of the docs is fixed to adapt to the proposed change in alignment with Diataxsis and issue #791

It fixes the spec navigation
Draft templates
Re-edits Release note page
Re-edits JSON hyper-schema page
Adds a Migration page

Does this PR introduce a breaking change?

No

metadata syntax fixes

Adding new table component

…into new-spec-structure

Draft 07 Fixes

Adding multiple file support

…into new-spec-structure

…o new-spec-structure

…into new-spec-structure

Getting back commits

…into web-feat-diataxis

benjagm

Thanks for this PR. I just added a lot of comments and suggestions.

pages/draft/2019-09/release-notes.md

benjagm · 2024-08-13T10:06:16Z

pages/draft/2019-09/release-notes.md

+- [Incompatible Changes](https://json-schema.org/draft/2019-09/release-notes#incompatible-changes)
+- [Semi-incompatible Changes](https://json-schema.org/draft/2019-09/release-notes#semi-incompatible-changes)
+- [Annotations, Errors, and Outputs](https://json-schema.org/draft/2019-09/release-notes#annotations-errors-and-outputs)
+- [Keyword Changes](https://json-schema.org/draft/2019-09/release-notes#keyword-changes)
+  - [Core Vocabulary](https://json-schema.org/draft/2019-09/release-notes#core-vocabulary)
+  - [Applicator Vocabulary](https://json-schema.org/draft/2019-09/release-notes#applicator-vocabulary)
+  - [Validation Vocabulary](https://json-schema.org/draft/2019-09/release-notes#validation-vocabulary)
+  - [Format Vocabulary](https://json-schema.org/draft/2019-09/release-notes#format-vocabulary)
+  - [Content Vocabulary](https://json-schema.org/draft/2019-09/release-notes#content-vocabulary)
+  - [Meta-Data Vocabulary](https://json-schema.org/draft/2019-09/release-notes#meta-data-vocabulary)
+  - [Hyper-Schema Vocabulary](https://json-schema.org/draft/2019-09/release-notes#hyper-schema-vocabulary)


Why changing the links from relative to absolute?

I don't understand what you mean?

pages/draft-07/json-schema-release-notes.md

pages/draft-06/json-schema-release-notes.md

pages/migration/index.md

pages/draft-07/index.md

pages/draft-06/index.md

pages/draft-05/index.md

benjagm · 2024-08-13T10:39:33Z

pages/json-hyper-schema/index.md

+- [Draft-07 to 2019-09](https://json-schema.org/draft/2019-09#hyper-schema-vocabulary)
+- [Draft-04 to Draft-07](https://json-schema.org/draft-07#json-hyper-schema-draft-07-release-notes)
+- [Draft-04 to Draft-06](https://json-schema.org/draft-06#json-hyper-schema-draft-06-release-notes)


All those links are broken.

Co-authored-by: Benjamin Granados <[email protected]>

kwennB · 2024-08-19T11:35:40Z

Hi @benjagm The commits you added to the Migration page introduced these errors. Could you take a look? thank you.

benjagm · 2024-08-26T09:31:39Z

Hi @benjagm The commits you added to the Migration page introduced these errors. Could you take a look? thank you.

I pushed some changes to fix this and other issues. Please check it and let me know.

kwennB · 2024-08-26T10:37:28Z

Hi @benjagm The commits you added to the Migration page introduced these errors. Could you take a look? thank you.

I pushed some changes to fix this and other issues. Please check it and let me know.

Thank you for the code. It works now.

benjagm

Hi Blessing. This looks great, my only 2 comments:

JSON Hyper Schema: Are we going to merge this and update the page afterwards after finishing the work with Jason? We need to check this with him.
Redirections:I don't see changes in the public/_redirects file. Remember we need to add here all the redirections avoid 404 errors afters changing the URLs ... for example in the release notes.

kwennB · 2024-09-13T06:37:00Z

Hi Blessing. This looks great, my only 2 comments:

JSON Hyper Schema: Are we going to merge this and update the page afterwards after finishing the work with Jason? We need to check this with him.

Redirections:I don't see changes in the public/_redirects file. Remember we need to add here all the redirections avoid 404 errors afters changing the URLs ... for example in the release notes.

Thank you Benja.

Yes let's merge and update afterwards.
I will work on the redirections now

benjagm

Thanks Blessing. I pushed some changes to:

Fix the redirects.
Fix broken links in json hyper schema.
change the date formats of the publication date of the json schema versions.

* Rebase with main (#821) * chore(deps): bump eslint-plugin-react from 7.33.2 to 7.35.0 (#813) Bumps [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) from 7.33.2 to 7.35.0. - [Release notes](https://github.com/jsx-eslint/eslint-plugin-react/releases) - [Changelog](https://github.com/jsx-eslint/eslint-plugin-react/blob/master/CHANGELOG.md) - [Commits](jsx-eslint/eslint-plugin-react@v7.33.2...v7.35.0) --- updated-dependencies: - dependency-name: eslint-plugin-react dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps): bump Renato66/auto-label from 3.0.0 to 3.1.0 (#809) Bumps [Renato66/auto-label](https://github.com/renato66/auto-label) from 3.0.0 to 3.1.0. - [Release notes](https://github.com/renato66/auto-label/releases) - [Commits](Renato66/auto-label@v3.0.0...v3.1.0) --- updated-dependencies: - dependency-name: Renato66/auto-label dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps): bump eslint-plugin-n from 16.3.1 to 16.6.2 (#810) Bumps [eslint-plugin-n](https://github.com/eslint-community/eslint-plugin-n) from 16.3.1 to 16.6.2. - [Release notes](https://github.com/eslint-community/eslint-plugin-n/releases) - [Changelog](https://github.com/eslint-community/eslint-plugin-n/blob/master/CHANGELOG.md) - [Commits](eslint-community/eslint-plugin-n@16.3.1...16.6.2) --- updated-dependencies: - dependency-name: eslint-plugin-n dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps): bump @types/react-syntax-highlighter (#812) Bumps [@types/react-syntax-highlighter](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/react-syntax-highlighter) from 15.5.10 to 15.5.13. - [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases) - [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/react-syntax-highlighter) --- updated-dependencies: - dependency-name: "@types/react-syntax-highlighter" dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps): bump @docsearch/react from 3.5.2 to 3.6.1 (#811) Bumps [@docsearch/react](https://github.com/algolia/docsearch) from 3.5.2 to 3.6.1. - [Release notes](https://github.com/algolia/docsearch/releases) - [Changelog](https://github.com/algolia/docsearch/blob/main/CHANGELOG.md) - [Commits](algolia/docsearch@v3.5.2...v3.6.1) --- updated-dependencies: - dependency-name: "@docsearch/react" dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Web release 3 (#655) * Standardize List Display with Card Component (#433) (#460) * Standardize List Display with Card Component (#433) * Addressed comments, added images, and implemented new styles * Increased padding on the x-axis * feat: added Faq section (#534) * Fix faq * Added Case Studies page in Overview Section (#473) * updated UI of blog-page * Added Case Studies Page * fixed linting errors * Added casestudies * changing index.page.tsx * Delete components/CustomComponent.tsx * Delete pages/overview/casestudies.md * removed unnecessary changes * removed unnecessary files * fixed bug * removed changes * removed unnecessary files * Pushing last changes. --------- Co-authored-by: Benjamin Granados <[email protected]> * feat: added resource section (#509) * fixed * feat: added resource section * feat: added resource section * revert changes cd6d848 * revert changes 65e9f3e * revert changes 877b0f0 * revert changes 74711cd * fix: fixed the width issue * revert change * fix: added resource icon * Tiny changes to adjust look and feel. * Last changes to fix dark theme --------- Co-authored-by: Benjamin Granados <[email protected]> * Feat: Add the Newsletter feature to the website. (#489) * initialize the Test directory. * Added the subscribe button. * Added the subscribe page. * Added the newsletter page. * changed name to newsletter. * removed the unwated code. * removed the unwated components. * decreased the horizontal width and changed the color. * decreased the font size. * Added the changes for the newsletter banner. * Added the newletter component to landing page. * added the color for input. * Added the required horizontal padding. * Added the required horizontal padding. for newsletter page. * Add changes to make it work with mailchimp * added the yarn file back. * Added yarn.lock file. * Update yarn.lock * linted the newsletter.tsx * linted newsletter * fix the index.page * Small improvement in page layout. * Fix dark theme behavior * . --------- Co-authored-by: AyushNautiyalDeveloper <[email protected]> Co-authored-by: Benjamin Granados <[email protected]> * Added welcome page (#566) * added welcome page * Pushed some changes to changes - Better location in sidebar - Changes to move what is json schema into getting started - move page inside overview --------- Co-authored-by: Benjamin Granados <[email protected]> * Added Use-cases page (#589) * added use-cases page, modified card component * fix * Added some changes to better merge with the dev branch. --------- Co-authored-by: Benjamin Granados <[email protected]> * Change docs link * fix: spacing between buttons (#575) * docs: added definition of json hyper-schema * fixed * fix: spacing b/w buttons * fix: added spacing in mobile design * fix: spacing on tablet screen * fix: spacing on less than 300px screen * community-page (#646) * community-page * Some final changes for the community page --------- Co-authored-by: Benjamin Granados <[email protected]> * Update Sidebar.tsx * Add resources file * Update Sidebar.tsx * Update case-studies.json * Text colours for dark theme * New version of the implementers page * Feat: Replacing Axios to fs fetching in resources page (#657) * cleaning * changing axios to fs * Remove articles from sidebar --------- Co-authored-by: Benjamin Granados <[email protected]> * Improve Case Studies and Use Cases welcome messages * adding codeowners * Fixing bugs and adding back lost files * fix sidebar dropdown for FAQ * community page major changes and faq bug fix * community page bug fixes and responsive issues in several pages * Update index.page.tsx (#684) * Update index.page.tsx Edited the placeholder texts for the welcome page. * fixed lint error * Edited wordings for the Welcome page of release 3 * Update pages/overview/welcome/index.page.tsx Co-authored-by: Benjamin Granados <[email protected]> * Update pages/overview/welcome/index.page.tsx Co-authored-by: Benjamin Granados <[email protected]> * Remove data duplication and fix intro text --------- Co-authored-by: Benjamin Granados <[email protected]> Co-authored-by: Benjamin Granados <[email protected]> * Feat: Removing resources and newletter from web-release-3 branch (#698) * removing newsletter * removing resources * removing resources.yml file * removing resources from welcomee page --------- Co-authored-by: Benjamin Granados <[email protected]> * case-studies bug fix and hover delay fix * adding ts comment * Small corrections * Update blogs link * Ambassadors button aligned to the left * Feat: Fixing responsive bugs from community page * community page bug fixes * Added uses cases texts * Last changes to use-cases * Add html to the use cases definition * feat:adding html parser for use-cases page * removing links from images * improved FAQ description text (#709) * improved FAQ description text * Updated FAQ general questions * Updated FAQ description text for fix one-sentence bug * Update data/faq.json Co-authored-by: Benjamin Granados <[email protected]> * Update data/faq.json Co-authored-by: Benjamin Granados <[email protected]> * Update data/faq.json Co-authored-by: Benjamin Granados <[email protected]> * Update pages/overview/faq/index.page.tsx --------- Co-authored-by: Benjamin Granados <[email protected]> * Improvement for case studies * merge confilts * removing merge conflicts * Fix:community card gap * Align with main branch * Align with main branch * Align with main branch * Update pages/overview/what-is-jsonschema.md Co-authored-by: Ben Hutton <[email protected]> * Remove welcome data file * Move welcome outside overview section * Change welcome text * Feat: Replaced axios with fetch * moved path to function * Updating community filters * Update pages/community/index.page.tsx Co-authored-by: Ben Hutton <[email protected]> * Fix the menu links * Update the JSON Schema calendar link * Change ambassadors image --------- Co-authored-by: Michael Obubelebra Amachree <[email protected]> Co-authored-by: Akshay Bagai <[email protected]> Co-authored-by: Tamanna <[email protected]> Co-authored-by: Ayush Nautiyal <[email protected]> Co-authored-by: AyushNautiyalDeveloper <[email protected]> Co-authored-by: VivekJaiswal18 <[email protected]> Co-authored-by: Neeraj Saini <[email protected]> Co-authored-by: Dhairya Majmudar <[email protected]> Co-authored-by: Dhairya Majmudar <[email protected]> Co-authored-by: Blessing Ene Anyebe <[email protected]> Co-authored-by: Ben Hutton <[email protected]> * Add docs help component (#820) * Feat: Refactoring toc styles (#796) * refactoring toc * updating es * adding heading * adding heading * New slack redirect --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Michael Obubelebra Amachree <[email protected]> Co-authored-by: Akshay Bagai <[email protected]> Co-authored-by: Tamanna <[email protected]> Co-authored-by: Ayush Nautiyal <[email protected]> Co-authored-by: AyushNautiyalDeveloper <[email protected]> Co-authored-by: VivekJaiswal18 <[email protected]> Co-authored-by: Neeraj Saini <[email protected]> Co-authored-by: Dhairya Majmudar <[email protected]> Co-authored-by: Dhairya Majmudar <[email protected]> Co-authored-by: Blessing Ene Anyebe <[email protected]> Co-authored-by: Ben Hutton <[email protected]> * Feat: Adding next-prev component (#807) * feat: next-prev-comp inital * activating buttons * New spec page structure- (#823) * Spec draft fixes * Updating draft sections * metadata syntax fixes * modified spec docs * adding table component * adding title * Spec draft fixes-2 * Spec draft fixes-3 * doc-table * fixing draft7 * draft7 fix * converting in links * adding multiple files * Spec draft fixes-4 * Spec draft fixes-5 * Spec draft fixes-6 * Modified spec page * Modified json hyper-schema page * Resolved feedbacks * Update pages/draft-06/json-schema-release-notes.md Co-authored-by: Benjamin Granados <[email protected]> * Update pages/draft/2019-09/release-notes.md Co-authored-by: Benjamin Granados <[email protected]> * Update pages/draft-07/json-schema-release-notes.md Co-authored-by: Benjamin Granados <[email protected]> * Update pages/migration/index.md Co-authored-by: Benjamin Granados <[email protected]> * Update pages/draft-07/index.md Co-authored-by: Benjamin Granados <[email protected]> * Update pages/migration/index.page.tsx Co-authored-by: Benjamin Granados <[email protected]> * Update components/Sidebar.tsx Co-authored-by: Benjamin Granados <[email protected]> * Update pages/release-notes/index.page.tsx Co-authored-by: Benjamin Granados <[email protected]> * Update pages/release-notes/index.md Co-authored-by: Benjamin Granados <[email protected]> * Update pages/draft-06/index.md Co-authored-by: Benjamin Granados <[email protected]> * Update pages/draft-05/index.md Co-authored-by: Benjamin Granados <[email protected]> * modified meta-schema and specification links for all drafts * Multiple changes * Updated JSON Hyperschema introductory text * updated URL redirects * Fix date formats, redirects and broken links --------- Co-authored-by: Dhairya Majmudar <[email protected]> Co-authored-by: Benjamin Granados <[email protected]> * fix merge issues * fix merge issues * Fix the usage of feedback component --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Michael Obubelebra Amachree <[email protected]> Co-authored-by: Akshay Bagai <[email protected]> Co-authored-by: Tamanna <[email protected]> Co-authored-by: Ayush Nautiyal <[email protected]> Co-authored-by: AyushNautiyalDeveloper <[email protected]> Co-authored-by: VivekJaiswal18 <[email protected]> Co-authored-by: Neeraj Saini <[email protected]> Co-authored-by: Dhairya Majmudar <[email protected]> Co-authored-by: Dhairya Majmudar <[email protected]> Co-authored-by: Blessing Ene Anyebe <[email protected]> Co-authored-by: Ben Hutton <[email protected]>

kwennB and others added 28 commits July 17, 2024 22:31

Spec draft fixes

8946f64

Merge branch 'json-schema-org:main' into new-spec-structure

37ca719

Updating draft sections

4292510

metadata syntax fixes

90410bf

Merge pull request #1 from DhairyaMajmudar/new-spec-structure

5dba363

metadata syntax fixes

modified spec docs

49c5145

adding table component

902d0ae

adding title

0e87086

Merge pull request #2 from DhairyaMajmudar/new-spec-structure

b207f98

Adding new table component

Spec draft fixes-2

bfcea46

Merge branch 'new-spec-structure' of https://github.com/kwennB/website …

52e562e

…into new-spec-structure

Spec draft fixes-3

bcd01d5

doc-table

e7730dc

fixing draft7

1d5f9df

draft7 fix

4df579f

converting in links

d94018b

Merge pull request #3 from DhairyaMajmudar/new-spec-structure

b144b8f

Draft 07 Fixes

Merge branch 'json-schema-org:main' into new-spec-structure

6251444

adding multiple files

68ff0c7

Merge pull request #4 from DhairyaMajmudar/new-spec-structure

d75b860

Adding multiple file support

Spec draft fixes-4

58cc4cf

Merge branch 'new-spec-structure' of https://github.com/kwennB/website …

653129d

…into new-spec-structure

Spec draft fixes-5

0e08ca7

Spec draft fixes-6

15ff1ad

Merge branch 'main' of https://github.com/json-schema-org/website int…

20ca8e7

…o new-spec-structure

Merge branch 'new-spec-structure' of https://github.com/kwennB/website …

c3176f2

…into new-spec-structure

resolving merge conflicts

ca9779c

Merge pull request #5 from DhairyaMajmudar/new-spec-structure

5f86cf3

Getting back commits

kwennB requested review from valeriahhdez and benjagm July 25, 2024 09:41

kwennB added 2 commits August 5, 2024 19:45

Resolved feedbacks

82466c7

Merge branch 'web-feat-diataxis' of https://github.com/kwennB/website …

3ae4cc9

…into web-feat-diataxis

DhairyaMajmudar added the GSoD Google Season of Docs label Aug 6, 2024

benjagm requested changes Aug 13, 2024

View reviewed changes

kwennB and others added 11 commits August 19, 2024 11:59

Update pages/draft-06/json-schema-release-notes.md

e87f7cc

Co-authored-by: Benjamin Granados <[email protected]>

Update pages/draft/2019-09/release-notes.md

c177a50

Co-authored-by: Benjamin Granados <[email protected]>

Update pages/draft-07/json-schema-release-notes.md

aed87d7

Co-authored-by: Benjamin Granados <[email protected]>

Update pages/migration/index.md

5775366

Co-authored-by: Benjamin Granados <[email protected]>

Update pages/draft-07/index.md

bdca8df

Co-authored-by: Benjamin Granados <[email protected]>

Update pages/migration/index.page.tsx

2ce491e

Co-authored-by: Benjamin Granados <[email protected]>

Update components/Sidebar.tsx

48d999b

Co-authored-by: Benjamin Granados <[email protected]>

Update pages/release-notes/index.page.tsx

45d38c6

Co-authored-by: Benjamin Granados <[email protected]>

Update pages/release-notes/index.md

cd1ea3a

Co-authored-by: Benjamin Granados <[email protected]>

Update pages/draft-06/index.md

aed478c

Co-authored-by: Benjamin Granados <[email protected]>

Update pages/draft-05/index.md

783d1d0

Co-authored-by: Benjamin Granados <[email protected]>

kwennB and others added 2 commits August 20, 2024 16:14

modified meta-schema and specification links for all drafts

eee932a

Multiple changes

f6212d0

Updated JSON Hyperschema introductory text

2b9cb35

kwennB mentioned this pull request Aug 28, 2024

[📝 Docs]: Create a dedicated JSON hyper-schema page #896

Open

1 task

benjagm requested changes Sep 12, 2024

View reviewed changes

kwennB and others added 2 commits September 13, 2024 09:37

updated URL redirects

9b6779b

Fix date formats, redirects and broken links

4954a25

benjagm approved these changes Sep 19, 2024

View reviewed changes

benjagm merged commit 3773f62 into json-schema-org:web-feat-diataxis Sep 19, 2024
4 checks passed

benjagm mentioned this pull request Sep 20, 2024

Docs release 4 : Rebuild the Spec docs #955

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New spec page structure- #823

New spec page structure- #823

kwennB commented Jul 25, 2024

benjagm left a comment

benjagm Aug 13, 2024

kwennB Aug 19, 2024

benjagm Aug 13, 2024

kwennB commented Aug 19, 2024

benjagm commented Aug 26, 2024

kwennB commented Aug 26, 2024

benjagm left a comment

kwennB commented Sep 13, 2024

benjagm left a comment

New spec page structure- #823

New spec page structure- #823

Conversation

kwennB commented Jul 25, 2024

benjagm left a comment

Choose a reason for hiding this comment

benjagm Aug 13, 2024

Choose a reason for hiding this comment

kwennB Aug 19, 2024

Choose a reason for hiding this comment

benjagm Aug 13, 2024

Choose a reason for hiding this comment

kwennB commented Aug 19, 2024

benjagm commented Aug 26, 2024

kwennB commented Aug 26, 2024

benjagm left a comment

Choose a reason for hiding this comment

kwennB commented Sep 13, 2024

benjagm left a comment

Choose a reason for hiding this comment