search

json-schema-org / website

JSON Schema website
https://json-schema.org
Other
67 stars 174 forks source link

Docs release 4 : Rebuild the Spec docs #955

Closed benjagm closed 1 month ago

benjagm commented 2 months ago

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: https://github.com/json-schema-org/website/issues/158

github-actions[bot] commented 2 months ago
built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
website ✅ Ready (View Log) Visit Preview b5c39cc567991458cec8a03f5e46b25e2d3710b5
codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

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

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

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

valeriahhdez commented 1 month ago

LGTM

Julian commented 1 month ago

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 commented 1 month ago

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.

benjagm commented 1 month ago

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 commented 1 month ago

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:

https://github.com/json-schema-org/website/pull/1010