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.

Sign up for GitHub

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

Jump to bottom

Docs release 4 : Rebuild the Spec docs #955

Merged
merged 7 commits into from
Oct 2, 2024
Merged

Docs release 4 : Rebuild the Spec docs #955

merged 7 commits into from
Oct 2, 2024

Conversation

benjagm
Copy link
Collaborator

@benjagm benjagm commented Sep 19, 2024 •
edited
Loading

What kind of change does this PR introduce?

Issue Number:

Summary

This PR contains the release 4 of the docs as described in the docs strategy: #158

benjagm and others added 6 commits July 24, 2024 16:37
@benjagm @dependabot
@Michael-Obele @Akshaybagai52 @TamannaVerma99 @ayushnau @AyushNautiyalDeveloper @VivekJaiswal18 @officeneerajsaini @DhairyaMajmudar @kwennB @Relequestual
Rebase with main (#821)
ae17022 
* 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]>
@benjagm
Merge branch 'web-feat-diataxis' of https://github.com/json-schema-or…
c384bf7 
…g/website into web-feat-diataxis
@DhairyaMajmudar
Feat: Adding next-prev component (#807)
e826579 
* feat: next-prev-comp inital

* activating buttons
@kwennB @DhairyaMajmudar @benjagm
New spec page structure- (#823)
3773f62 
* 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]>
@benjagm
fix merge issues
a621c25
@benjagm
fix merge issues
9640ee9
@github-actions GitHub Actions
Copy link

github-actions bot commented Sep 19, 2024 •
edited
Loading

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
website ✅ Ready (View Log) Visit Preview b5c39cc

@codecov Codecov
Copy link

codecov bot commented Sep 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (main@753017b). Learn more about missing BASE report.

Additional details and impacted files 
@@           Coverage Diff            @@
##             main      #955   +/-   ##
========================================
  Coverage        ?   100.00%           
========================================
  Files           ?        10           
  Lines           ?       373           
  Branches        ?        94           
========================================
  Hits            ?       373           
  Misses          ?         0           
  Partials        ?         0

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@benjagm benjagm changed the title Web feat diataxis Docs release 4 : Rebuild the Spec docs Sep 19, 2024
kwennB
kwennB reviewed Sep 19, 2024
View reviewed changes
Copy link
Contributor

@kwennB kwennB left a comment

Choose a reason for hiding this comment

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

Review added, thank you.

components/NextPrevButton.tsx Show resolved Hide resolved
pages/draft-06/json-hyper-schema-release-notes.md Show resolved Hide resolved
pages/draft-07/json-hyper-schema-release-notes.md Show resolved Hide resolved
@kwennB kwennB marked this pull request as ready for review September 23, 2024 11:24
@kwennB kwennB requested a review from a team as a code owner September 23, 2024 11:24
@valeriahhdez
Copy link
Contributor

LGTM

kwennB
kwennB approved these changes Sep 24, 2024
View reviewed changes
Copy link
Contributor

@kwennB kwennB left a comment

Choose a reason for hiding this comment

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

It's all good now.

DarhkVoyd
DarhkVoyd requested changes Sep 24, 2024
View reviewed changes
Copy link
Member

@DarhkVoyd DarhkVoyd left a comment

Choose a reason for hiding this comment

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

Most of the changes are docs related so I just skimmed over the changes, on the technical side I left a comment.

public/_redirects Show resolved Hide resolved
@benjagm benjagm merged commit 8a71938 into main Oct 2, 2024
9 checks passed
@benjagm benjagm deleted the web-feat-diataxis branch October 2, 2024 08:11
@Julian
Copy link
Member

Julian commented Oct 6, 2024

Do we have a policy on preserving links / adding redirects when we change something? Specifically I think this PR broke a few -- I notice because my CI (on python-jsonschema) has begun to fail. A specific example is https://json-schema.org/draft/2019-09/release-notes.html#format-vocabulary which used to resolve and is now a 404.

I'm going to update my links to unbreak CI on my side but just flagging in case this wasn't intentional.

@Julian
Copy link
Member

Julian commented Oct 6, 2024 •
edited
Loading

More specifically, two things seem to have changed in that specific example, judging from the new link, which seems to be:

https://json-schema.org/draft/2019-09#format-vocabulary

That looks quite unintentional -- specifically the new URL for release notes seems to be https://json-schema.org/draft/2019-09#draft-2019-09-release-notes, and the new fragment for the format vocabulary changes within the release notes seems to be https://json-schema.org/draft/2019-09#format-vocabulary where the fragment is no longer nested even inside release-notes so there's no visual indication that this is release note related.

Julian added a commit to python-jsonschema/jsonschema that referenced this pull request Oct 6, 2024
@Julian
Fix a broken link which has changed on the JSON Schema website.
08395e9 
This new link seems a bit wrong and likely to change again to me, but
for now, the old link is a 404...

Refs: json-schema-org/website#955
@benjagm
Copy link
Collaborator Author

benjagm commented Oct 7, 2024

Sorry for the situation @Julian . We created some redirects that should have avoided the 404, but for any reason they are not working as expected. This added to your comment regarding the URL structure makes me think about reverting the change and coming back to the previous release notes structure. I am planning to have this done later today

@benjagm
Copy link
Collaborator Author

benjagm commented Oct 9, 2024

Hi everyone! Thanks a lot for helping us find the problems created by the changes in the release notes. This PR fixes all making the all release notes accessible again:

#1010

@benjagm benjagm mentioned this pull request Oct 9, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DarhkVoyd DarhkVoyd DarhkVoyd requested changes

@kwennB kwennB kwennB approved these changes

@valeriahhdez valeriahhdez valeriahhdez approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[📝 Docs]: Implement the Spec page restructuring (Docs Website)
6 participants
@benjagm @valeriahhdez @Julian @kwennB @DarhkVoyd @DhairyaMajmudar