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

add support information #201

Merged
merged 14 commits into from Dec 2, 2022
Merged

add support information #201

merged 14 commits into from Dec 2, 2022

Conversation

lgs85
Copy link
Contributor

@lgs85 lgs85 commented Nov 25, 2022

Related issues

Description

Merge checklist

  • Update the changelog (style guide)
  • Run ./manage.py pre-commit to update derivative schema files, reference documentation and examples

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

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

@duncandewhurst
Copy link
Collaborator

Should we also add a support page to the standard documentation? For reference, OCDS has a Getting Help page.

@lgs85 lgs85 changed the title add support email to readme add support information Dec 1, 2022
@lgs85
Copy link
Contributor Author

lgs85 commented Dec 1, 2022

@duncandewhurst good plan - have now added a (heavily cribbed) support page.

Copy link
Collaborator

@duncandewhurst duncandewhurst left a comment

Choose a reason for hiding this comment

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

Looks good! Just a few minor copy-edits.

docs/support/index.md Outdated Show resolved Hide resolved
docs/support/index.md Outdated Show resolved Hide resolved
docs/support/index.md Outdated Show resolved Hide resolved
docs/support/index.md Outdated Show resolved Hide resolved
docs/support/index.md Outdated Show resolved Hide resolved
docs/support/index.md Outdated Show resolved Hide resolved
docs/support/index.md Outdated Show resolved Hide resolved
lgs85 and others added 8 commits December 2, 2022 08:17
Co-authored-by: Duncan Dewhurst <duncan.dewhurst@opendataservices.coop>
Co-authored-by: Duncan Dewhurst <duncan.dewhurst@opendataservices.coop>
Co-authored-by: Duncan Dewhurst <duncan.dewhurst@opendataservices.coop>
Co-authored-by: Duncan Dewhurst <duncan.dewhurst@opendataservices.coop>
Co-authored-by: Duncan Dewhurst <duncan.dewhurst@opendataservices.coop>
Co-authored-by: Duncan Dewhurst <duncan.dewhurst@opendataservices.coop>
Co-authored-by: Duncan Dewhurst <duncan.dewhurst@opendataservices.coop>
@lgs85 lgs85 dismissed duncandewhurst’s stale review December 2, 2022 09:07

all changes accepted

@lgs85 lgs85 merged commit d463f39 into 0.1-dev Dec 2, 2022
@lgs85 lgs85 deleted the lgs85-patch-1 branch December 2, 2022 09:08
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.

None yet

3 participants