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

docs/primer/openfibredatastandard.md: Emphasise categories of data #264

Merged
merged 4 commits into from
May 17, 2023
Merged

docs/primer/openfibredatastandard.md: Emphasise categories of data #264

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e94c29d
docs/primer/openfibredatastandard.md: Emphasis categories of data
duncandewhurst May 3, 2023
85597a7
Update changelog
duncandewhurst May 3, 2023
9c414b5
Merge branch '0.3-dev' into 235-update-primer
duncandewhurst May 9, 2023
3f3a7e5
Merge branch '0.3-dev' into 235-update-primer
duncandewhurst May 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/history/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ Iterative improvements are made outside of the release cycle. They do not involv
### Non-normative documentation

- [#259](https://github.com/Open-Telecoms-Data/open-fibre-data-standard/pull/259) - Fix link to Lib CoVE OFDS.
- [#264](https://github.com/Open-Telecoms-Data/open-fibre-data-standard/pull/264) - Update primer to emphasise technical and administrative data.
- [#268](https://github.com/Open-Telecoms-Data/open-fibre-data-standard/pull/268) - Quote code descriptions from CSV files.

### Build
Expand Down
4 changes: 4 additions & 0 deletions docs/primer/openfibredatastandard.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ The OFDS provides:
- Publication formats to meet a range of use cases.
- Guidance and tooling to support the publication and use of data

The OFDS covers the location of fibre infrastructure and the technical and administrative attributes of fibre infrastructure.

## Why use the Open Fibre Data Standard?

Data standards resolve ambiguity by defining the structure and meaning of data. Standardised data is easier for people and systems to interpret than non-standardised data:
Expand All @@ -36,6 +38,8 @@ Since all of the above units can be converted into Gbps, OFDS requires that publ

Standards can also ensure that key information is included in a dataset. If data owners do not share key information in their data, then users need to negotiate with each data owner individually.

In addition to publishing the locations of fibre network infrastructure, using the OFDS to publish data on the technical and administrative attributes of infrastructure helps to ensure that your data meets the needs of a range of users. For example, publishing data on the organisations that own and operate infrastructure can help operators and regulators to understand the true extent and resilience of fibre networks.

## What does OFDS data look like?

To meet the needs of different users, OFDS data can be published in three formats: JSON, GeoJSON and CSV. The tabs below provide examples of OFDS data in each format:
Expand Down