Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New spec page structure- #823

Merged
merged 49 commits into from
Sep 19, 2024

Conversation

kwennB
Copy link
Contributor

@kwennB kwennB commented Jul 25, 2024

What kind of change does this PR introduce?

Documentation Enhancement
Spec-structure-json

Issue Number:

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

kwennB and others added 28 commits July 17, 2024 22:31
@DhairyaMajmudar DhairyaMajmudar added the GSoD Google Season of Docs label Aug 6, 2024
Copy link
Collaborator

@benjagm benjagm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

pages/draft/2019-09/release-notes.md Outdated Show resolved Hide resolved
Comment on lines +9 to +19
- [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)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why changing the links from relative to absolute?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand what you mean?

pages/draft-07/json-schema-release-notes.md Outdated Show resolved Hide resolved
pages/draft-06/json-schema-release-notes.md Outdated Show resolved Hide resolved
pages/migration/index.md Outdated Show resolved Hide resolved
pages/draft-07/index.md Outdated Show resolved Hide resolved
pages/draft-06/index.md Outdated Show resolved Hide resolved
pages/draft-05/index.md Outdated Show resolved Hide resolved
pages/draft-05/index.md Outdated Show resolved Hide resolved
Comment on lines 23 to 25
- [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)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All those links are broken.

kwennB and others added 11 commits August 19, 2024 11:59
Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com>
Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com>
Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com>
Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com>
Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com>
Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com>
Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com>
Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com>
Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com>
Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com>
Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com>
@kwennB
Copy link
Contributor Author

kwennB commented Aug 19, 2024

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

image

@benjagm
Copy link
Collaborator

benjagm commented Aug 26, 2024

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
Copy link
Contributor Author

kwennB commented Aug 26, 2024

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.

Copy link
Collaborator

@benjagm benjagm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Contributor Author

kwennB commented Sep 13, 2024

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

Copy link
Collaborator

@benjagm benjagm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@benjagm benjagm merged commit 3773f62 into json-schema-org:web-feat-diataxis Sep 19, 2024
4 checks passed
benjagm added a commit that referenced this pull request Oct 2, 2024
* 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] <support@github.com>
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] <support@github.com>
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] <support@github.com>
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] <support@github.com>
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] <support@github.com>
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 <benjamin.granadosm@gmail.com>

* 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 <benjamin.granadosm@gmail.com>

* 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 <ayush@betalectic.com>
Co-authored-by: Benjamin Granados <benjamin.granadosm@gmail.com>

* 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 <benjamin.granadosm@gmail.com>

* 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 <benjamin.granadosm@gmail.com>

* 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 <benjamin.granadosm@gmail.com>

* 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 <benjamin.granadosm@gmail.com>

* 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 <40007659+benjagm@users.noreply.github.com>

* Update pages/overview/welcome/index.page.tsx

Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com>

* Remove data duplication and fix intro text

---------

Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com>
Co-authored-by: Benjamin Granados <benjamin.granadosm@gmail.com>

* 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 <40007659+benjagm@users.noreply.github.com>

* 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 <40007659+benjagm@users.noreply.github.com>

* Update data/faq.json

Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com>

* Update data/faq.json

Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com>

* Update pages/overview/faq/index.page.tsx

---------

Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com>

* 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 <relequestual@gmail.com>

* 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 <relequestual@gmail.com>

* Fix the menu links

* Update the JSON Schema calendar link

* Change ambassadors image

---------

Co-authored-by: Michael Obubelebra Amachree <amachree9630@gmail.com>
Co-authored-by: Akshay Bagai <100753870+Akshaybagai52@users.noreply.github.com>
Co-authored-by: Tamanna <96949249+TamannaVerma99@users.noreply.github.com>
Co-authored-by: Ayush Nautiyal <78146753+ayushnau@users.noreply.github.com>
Co-authored-by: AyushNautiyalDeveloper <ayush@betalectic.com>
Co-authored-by: VivekJaiswal18 <96608169+VivekJaiswal18@users.noreply.github.com>
Co-authored-by: Neeraj Saini <118799941+officeneerajsaini@users.noreply.github.com>
Co-authored-by: Dhairya Majmudar <124715224+DhairyaMajmudar@users.noreply.github.com>
Co-authored-by: Dhairya Majmudar <2022kuec2045@iiitkota.ac.in>
Co-authored-by: Blessing Ene Anyebe <60541622+kwennB@users.noreply.github.com>
Co-authored-by: Ben Hutton <relequestual@gmail.com>

* 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] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Michael Obubelebra Amachree <amachree9630@gmail.com>
Co-authored-by: Akshay Bagai <100753870+Akshaybagai52@users.noreply.github.com>
Co-authored-by: Tamanna <96949249+TamannaVerma99@users.noreply.github.com>
Co-authored-by: Ayush Nautiyal <78146753+ayushnau@users.noreply.github.com>
Co-authored-by: AyushNautiyalDeveloper <ayush@betalectic.com>
Co-authored-by: VivekJaiswal18 <96608169+VivekJaiswal18@users.noreply.github.com>
Co-authored-by: Neeraj Saini <118799941+officeneerajsaini@users.noreply.github.com>
Co-authored-by: Dhairya Majmudar <124715224+DhairyaMajmudar@users.noreply.github.com>
Co-authored-by: Dhairya Majmudar <2022kuec2045@iiitkota.ac.in>
Co-authored-by: Blessing Ene Anyebe <60541622+kwennB@users.noreply.github.com>
Co-authored-by: Ben Hutton <relequestual@gmail.com>

* 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 <40007659+benjagm@users.noreply.github.com>

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

Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com>

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

Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com>

* Update pages/migration/index.md

Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com>

* Update pages/draft-07/index.md

Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com>

* Update pages/migration/index.page.tsx

Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com>

* Update components/Sidebar.tsx

Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com>

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

Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com>

* Update pages/release-notes/index.md

Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com>

* Update pages/draft-06/index.md

Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com>

* Update pages/draft-05/index.md

Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com>

* 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 <2022kuec2045@iiitkota.ac.in>
Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com>

* fix merge issues

* fix merge issues

* Fix the usage of feedback component

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Michael Obubelebra Amachree <amachree9630@gmail.com>
Co-authored-by: Akshay Bagai <100753870+Akshaybagai52@users.noreply.github.com>
Co-authored-by: Tamanna <96949249+TamannaVerma99@users.noreply.github.com>
Co-authored-by: Ayush Nautiyal <78146753+ayushnau@users.noreply.github.com>
Co-authored-by: AyushNautiyalDeveloper <ayush@betalectic.com>
Co-authored-by: VivekJaiswal18 <96608169+VivekJaiswal18@users.noreply.github.com>
Co-authored-by: Neeraj Saini <118799941+officeneerajsaini@users.noreply.github.com>
Co-authored-by: Dhairya Majmudar <124715224+DhairyaMajmudar@users.noreply.github.com>
Co-authored-by: Dhairya Majmudar <2022kuec2045@iiitkota.ac.in>
Co-authored-by: Blessing Ene Anyebe <60541622+kwennB@users.noreply.github.com>
Co-authored-by: Ben Hutton <relequestual@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
GSoD Google Season of Docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants