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

docs/reference/publication_formats/json.md: Fix broken schema browser #184

Merged
merged 19 commits into from
Nov 11, 2022

Conversation

duncandewhurst
Copy link
Collaborator

@duncandewhurst duncandewhurst commented Nov 10, 2022

Related issues
Add links to related issues here. Use keywords if you want an issue to be automatically closed when the PR is merged.

Description
If the changes in the PR are not sufficiently explained by the related issues and commit messages, add a description here

This PR fixes the broken schema browser in https://open-fibre-data-standard.readthedocs.io/en/latest/reference/publication_formats/json.html#small-files-and-api-responses-option

Preview: https://open-fibre-data-standard.readthedocs.io/en/network-package-schema-browser/reference/publication_formats/json.html#small-files-and-api-responses-option

Merge checklist

  • If there are changes to network-schema.json, network-package-schema.json, reference/publication_formats/json.md, reference/publication_formats/geojson.md or guidance/publication.md#how-to-publish-large-networks, update the relevant manually authored examples:
    • examples/json/:
      • network-package.json
      • api-response.json
      • multiple-networks.json
      • network-embedded.json
      • network-separate-endpoints.json
      • network-separate-files.json
      • nodes-endpoint.json
      • spans-endpoint.json
    • examples/geojson/:
      • api-response.geojson
      • multiple-networks.geojson
  • Run ./manage.py pre-commit to update derivative schema files, reference documentation and examples
  • If you used a validation keyword, type or format that is not already used in the schema:
  • If you added a normative rule that is not encoded in JSON Schema:
  • If there are changes to examples/geojson/nodes.geojson or examples/geojson/spans.geojson, check and update the data use examples:
    • examples/leaflet/leaflet.ipynb
    • examples/qgis/geojson.qgs
  • Update the changelog (style guide)

@duncandewhurst
Copy link
Collaborator Author

I think that we can merge this into 0.1 without creating a new tagged release as it's just a fix to how the docs site renders. We can then merge 0.1 into 0.1-dev so that they are not out of sync.

As you can see, I encountered some challenges getting this to work because it behaves differently locally and on ReadTheDocs and because I didn't realise that the two URLs are relative to different locations: Open-Telecoms-Data/standard-development-handbook#22

@duncandewhurst duncandewhurst marked this pull request as ready for review November 10, 2022 22:08
@duncandewhurst duncandewhurst requested a review from lgs85 November 10, 2022 22:08
@duncandewhurst duncandewhurst changed the base branch from 0.1-dev to 0.1 November 10, 2022 22:09
@lgs85 lgs85 merged commit 471a2d5 into 0.1 Nov 11, 2022
@lgs85 lgs85 deleted the network-package-schema-browser branch November 11, 2022 10:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants