Publication formats #90
Conversation
docs/guidance/publication.md
Outdated
| To convert a network to GeoJSON format: | ||
|
|
||
| * Check out the [repository](https://github.com/Open-Telecoms-Data/open-fibre-data-standard) | ||
| * Run the [get started commands](https://ofds-standard-development-handbook.readthedocs.io/en/latest/technical/build.html#get-started) |
There was a problem hiding this comment.
| * Run the [get started commands](https://ofds-standard-development-handbook.readthedocs.io/en/latest/technical/build.html#get-started) | |
| * Run the [get started commands](https://ofds-standard-development-handbook.readthedocs.io/en/latest/technical/build.html#get-started) in the OFDS developer handbook. |
This is not ideal, as it blurs the boundary between publisher and developer documentation. Might it better to replicate the getting started instructions here until we have a standalone tools?
There was a problem hiding this comment.
Done in 3044614
docs/guidance/publication.md
Outdated
|
|
||
| To convert a network to GeoJSON format: | ||
|
|
||
| * Check out the [repository](https://github.com/Open-Telecoms-Data/open-fibre-data-standard) |
There was a problem hiding this comment.
Done in 048dbff
|
|
||
| :::{tab-item} Small file example | ||
| The following example shows a network package containing two networks: | ||
| ```{jsoninclude} ../../examples/json/network-package.json |
There was a problem hiding this comment.
I think it would be good to add a few example fields here, clarity
There was a problem hiding this comment.
Done in 2b4ae25
| The following example shows a JSON Lines file containing two networks: | ||
|
|
||
| ``` | ||
| {"id": "1"} |
There was a problem hiding this comment.
Again I think a few more example fields would be useful here
There was a problem hiding this comment.
Done in 2b4ae25
| The following example shows a newline-delimited GeoJSON file containing two features: | ||
|
|
||
| ``` | ||
| {"type": "Feature"} |
There was a problem hiding this comment.
Can we add a few more example fields here too?
There was a problem hiding this comment.
Done in 2b4ae25
Co-authored-by: Lewis Spurgin <lewisspurgin@gmail.com>
Co-authored-by: Lewis Spurgin <lewisspurgin@gmail.com>
'Resolving merge conflicts'
Related to #51, #75, #82 and #37
This PR integrates the content from the proposal in #51 to the publication formats reference, adds guidance on publishing large networks in JSON format, based on the proposal in #75 and adds general guidance on publication formats.
@lgs85 contrary to our discussion about separating the packaging reference from the publication formats reference, I realised it would be simpler to integrate them and require that data is published using one of the packaging/publication formats, which are now one and the same. Otherwise, it gets very confusing to have both publication formats and packaging formats.
I struggled to integrate the guidance on paginating/streaming nodes and links to the reference on paginating/streaming whole networks, so it is currently sat in the guidance, but we might want to move it to the reference if you can think of a good way of integrating it.