Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
69 commits
Select commit Hold shift + click to select a range
2c6eb9c
Create spell_checker.yml
kathryn-ods Jun 6, 2025
51d321d
Create spellcheck.yml
kathryn-ods Jun 6, 2025
c49b556
Update spell_checker.yml
kathryn-ods Jun 6, 2025
5238cac
Update and rename spellcheck.yml to .spellcheck.yml
kathryn-ods Jun 6, 2025
a587954
Update .spellcheck.yml
kathryn-ods Jun 6, 2025
96c0a6f
Update .spellcheck.yml
kathryn-ods Jun 6, 2025
dca447c
Create .wordlist.txt
kathryn-ods Jun 6, 2025
eb6e506
Update .spellcheck.yml
kathryn-ods Jun 6, 2025
9589a30
Update .spellcheck.yml
kathryn-ods Jun 6, 2025
091e7ed
Update .spellcheck.yml
kathryn-ods Jun 6, 2025
c0050e7
Update .spellcheck.yml
kathryn-ods Jun 6, 2025
abbb0cf
Update .wordlist.txt
kathryn-ods Jun 6, 2025
9462db7
Update spell_checker.yml
kathryn-ods Jun 6, 2025
517b3de
Update spell_checker.yml
kathryn-ods Jun 6, 2025
65f1610
Update .wordlist.txt
kathryn-ods Jun 6, 2025
8650347
Update .wordlist.txt
kathryn-ods Jun 6, 2025
5466b9e
Update .spellcheck.yml
kathryn-ods Jun 6, 2025
71a7540
Update .spellcheck.yml
kathryn-ods Jun 6, 2025
1da28f0
Update .spellcheck.yml
kathryn-ods Jun 6, 2025
8f4d374
Update .spellcheck.yml
kathryn-ods Jun 6, 2025
d50e2cc
Update .spellcheck.yml
kathryn-ods Jun 6, 2025
667bf0c
Update .wordlist.txt
kathryn-ods Jun 10, 2025
8bd0a5c
Update .wordlist.txt
kathryn-ods Jun 10, 2025
86a7fd1
Update .wordlist.txt
kathryn-ods Jun 10, 2025
5dbf3ef
Update .wordlist.txt
kathryn-ods Jun 10, 2025
5d96237
Update .spellcheck.yml
kathryn-ods Jun 10, 2025
08936ee
Update privacy-notice.md
kathryn-ods Jun 10, 2025
e572b3a
Update index.md
kathryn-ods Jun 10, 2025
48783f8
Update communication_channels.md
kathryn-ods Jun 10, 2025
0c61869
Update communication_channels.md
kathryn-ods Jun 10, 2025
e28900a
Update spreadsheet_template.md
kathryn-ods Jun 10, 2025
1868c2c
Update advocacy_plan.md
kathryn-ods Jun 10, 2025
fe3be76
Update demonstration_applications.md
kathryn-ods Jun 10, 2025
780bd3a
Update communications_plan.md
kathryn-ods Jun 10, 2025
6ec9f3c
Update validator.md
kathryn-ods Jun 10, 2025
3ee4fbd
Update example_data.md
kathryn-ods Jun 10, 2025
02e7e7f
Update logo.md
kathryn-ods Jun 10, 2025
90216fc
Update conversion_tools.md
kathryn-ods Jun 10, 2025
f68d8e3
Update commitment_templates.md
kathryn-ods Jun 10, 2025
259fdbf
Update developer_guidelines.md
kathryn-ods Jun 10, 2025
c965633
Update index.md
kathryn-ods Jun 10, 2025
5d0c72f
Update getting_started_documentation.md
kathryn-ods Jun 10, 2025
ec11722
Update reference_lists.md
kathryn-ods Jun 10, 2025
495cfb1
Update translation.md
kathryn-ods Jun 10, 2025
76084ae
Update recommended_data_license.md
kathryn-ods Jun 11, 2025
ea6df4e
Update icons.md
kathryn-ods Jun 11, 2025
a2aa434
Update translation.md
kathryn-ods Jun 11, 2025
88e747f
Update .wordlist.txt
kathryn-ods Jun 11, 2025
fc546bf
Update documentation.md
kathryn-ods Jun 11, 2025
b0d6c4b
Update getting-started.md
kathryn-ods Jun 11, 2025
b6276a2
Update .wordlist.txt
kathryn-ods Jun 11, 2025
cd6af7c
Update getting-started.md
kathryn-ods Jun 11, 2025
b7f8336
Update stages.md
kathryn-ods Jun 11, 2025
c67e3d4
Update governance.md
kathryn-ods Jun 11, 2025
dd9c49c
Update index.md
kathryn-ods Jun 11, 2025
a254949
Update schema.md
kathryn-ods Jun 11, 2025
29efb1a
Update .wordlist.txt
kathryn-ods Jun 11, 2025
003a57a
Update index.md
kathryn-ods Jun 12, 2025
586305a
Update schema.md
kathryn-ods Jun 12, 2025
326b9ed
Update schema.md
kathryn-ods Jun 12, 2025
8428951
Update getting-started.md
kathryn-ods Jun 12, 2025
7342893
Update schema.md
kathryn-ods Jun 12, 2025
8016201
Update .wordlist.txt
kathryn-ods Jun 12, 2025
42b3f5c
Update .wordlist.txt
kathryn-ods Jun 12, 2025
74a1229
Update .wordlist.txt
kathryn-ods Jun 12, 2025
a980c2d
Update documentation.md
kathryn-ods Jun 13, 2025
128c1d8
Update .wordlist.txt
kathryn-ods Jun 13, 2025
591699d
Update .wordlist.txt
kathryn-ods Jun 13, 2025
572eda6
Merge branch 'live' into spellcheck
kathryn-ods Jun 13, 2025
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
12 changes: 12 additions & 0 deletions .github/workflows/spell_checker.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: Spellcheck Action
on: [push, pull_request]

jobs:
build:
name: Spellcheck
runs-on: ubuntu-latest
steps:
# The checkout step
- uses: actions/checkout@v3
- uses: rojopolis/spellcheck-github-actions@v0
name: Spellcheck
21 changes: 21 additions & 0 deletions .spellcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
matrix:
- name: Markdown
aspell:
lang: en
d: en_GB
dictionary:
wordlists:
- .wordlist.txt
output: wordlist.dic
encoding: utf-8
pipeline:
- pyspelling.filters.url:
- pyspelling.filters.markdown:
- pyspelling.filters.html:
comments: false
ignores:
- code
- pre
sources:
- 'docs/**/*.md'
default_encoding: utf-8
77 changes: 77 additions & 0 deletions .wordlist.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
Airtable
APIs
bestValueToGovernment
Bytemark
Changelog
changelog
changelogs
codelist
codelists
COH
contratación
CoVE
CRM
CSV
Deprioritisation
dev
DoNotTrack
dropdown
eval
funders
GDPR
GeoJSON
GitHub
grantmakers
GrantNav
helpdesk
Helpdesk
Holyoake
howto
hypothes
IATI
ICO
IETF
ILDA
implementers
incentivise
io
json
licitación
LinkedIn
Matomo
maxdepth
multilingually
NGOs
OCDS
oferta
ontologies
opendataservices
Parsers
po
pre
programmatically
propuesta
pseudonymised
ratedCriteria
readthedocs
recommonmark
RedmineUp
reproducibility
reStructuredText
roadmap
rst
rulesets
schema's
schemas
seealso
SSOT
symlink
toctree
Transifex
USD
validator
validators
VLOOKUP
Wardley's
XLS
XLSX
2 changes: 1 addition & 1 deletion docs/about/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Open Data Services Co-operative was established in 2015 to support organisations to publish and use open data. We have a particular focus on incubating early stage open data standards, and supporting the development of effective transparency and collaboration initiatives using well-maintained open data standards.

We often act as the technical partner to policy-focussed initiatives, working under contract to develop and maintain open data standards, and to support standard implementation.
We often act as the technical partner to policy-focused initiatives, working under contract to develop and maintain open data standards, and to support standard implementation.

Our team of employees and members work across a range of tasks:

Expand Down
2 changes: 1 addition & 1 deletion docs/components/advocacy_plan.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Summary

Setting out steps to encourage organizations to adopt the standard.
Setting out steps to encourage organisations to adopt the standard.

## Description

Expand Down
2 changes: 1 addition & 1 deletion docs/components/commitment_templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Draft commitments are templates for adopters to copy or adapt before signing and
## Prioritisation Factors

- If a standard requires a relatively high level of commitment to be useful
- If a standard is targetting public sector organisations that are keen to formally launch commitments
- If a standard is targeting public sector organisations that are keen to formally launch commitments
- If a very early-stage standard requires commitment in principle before development begins


6 changes: 3 additions & 3 deletions docs/components/communication_channels.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ Used to communicate with implementers, users and other stakeholders.
Different communication channels suit different audiences and content types, for example:

* A *blog* that is regularly updated can provide updates to the community, resources for them to refer back to, and act as a 'shop window' for the standard, demonstrating that it is maintained and used.
* Public *social media channels* such as a LinkedIn page allow a standard to communicate little and often, and to engage with their communities in a relateable way. Some open communities already have a strong presence on microblogging sites, so the friction for engagement is reduced.
* Public *social media channels* such as a LinkedIn page allow a standard to communicate little and often, and to engage with their communities in a relatable way. Some open communities already have a strong presence on social media sites, so the friction for engagement is reduced.

* An *email list* is a widely-accessible and low-cost way for a group to hold discussions, and many email list providers offer a public archive service so that accountability is maintained. Standards often have a discussion list and a separate announcement list, so that members can choose how involved they want to be. The asynchronous nature of email lists allows users to be involved as regularly or infrequently as they prefer. However, some users are reticent to post to public email lists for fear of appearing foolish or having their words during their learning being recorded.
* An *email list* is a widely accessible and low-cost way for a group to hold discussions, and many email list providers offer a public archive service so that accountability is maintained. Standards often have a discussion list and a separate announcement list, so that members can choose how involved they want to be. The asynchronous nature of email lists allows users to be involved as regularly or infrequently as they prefer. However, some users are reticent to post to public email lists for fear of appearing foolish or having their words during their learning being recorded.

## Prioritisation factors

Expand All @@ -26,4 +26,4 @@ Different communication channels suit different audiences and content types, for

* Blogs: If there isn't the resource available to make regular updates.
* Social media: If the time, people or infrastructure required to make regular updates is not available
* Email lists: If there is reticence among users about public email lists
* Email lists: If there is reticence among users about public email lists
2 changes: 1 addition & 1 deletion docs/components/communications_plan.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Setting out steps to get media coverage of the standard.

## Description

A communications plan sets out the steps that are planned to encourage media coverage of the standard. Having a plan ensures that media opportunities are sought, and that representatives of the standard are well-equipped when taking advantage of opportunities. It can ensure that the standard is properly represented, setting expectations among potential users and beneficaries.
A communications plan sets out the steps that are planned to encourage media coverage of the standard. Having a plan ensures that media opportunities are sought, and that representatives of the standard are well-equipped when taking advantage of opportunities. It can ensure that the standard is properly represented, setting expectations among potential users and beneficiaries.

## Prioritisation Factors

Expand Down
4 changes: 2 additions & 2 deletions docs/components/conversion_tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

## Summary

Allowing conversion between serialization formats (e.g. CSV -> XML; JSON -> XLS)
Allowing conversion between serialisation formats (e.g. CSV -> XML; JSON -> XLS)

## Description

Data standards often use structured data formats such as JSON or XML to give more flexbility in modelling and to allow validation against schema. Typically, developers prefer to work with structured data formats as they are easier to work with in programs. However, JSON and XML aren't very human-friendly, and people working with data in many domains prefer to use flat representations of data such as CSV and XLSX spreadsheets, both for publishing and manipulating data. Conversion tools allow conversion between the formats, to allow the standard and developers to retain the benfits of a structured data format and users to continue to be able to engage with the data in a way that they're comfortable with.
Data standards often use structured data formats such as JSON or XML to give more flexibility in modelling and to allow validation against schema. Typically, developers prefer to work with structured data formats as they are easier to work with in programs. However, JSON and XML aren't very human-friendly, and people working with data in many domains prefer to use flat representations of data such as CSV and XLSX spreadsheets, both for publishing and manipulating data. Conversion tools allow conversion between the formats, to allow the standard and developers to retain the benefits of a structured data format and users to continue to be able to engage with the data in a way that they're comfortable with.

## Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/components/demonstration_applications.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Showcasing what can be done with data when it is published to a standard

## Description

Demonstration applications are either real-world or contrived applications using standardised data to illustrate what the data could be used for. They can be used to demonstrate the advantages of using the standard at all, or using particular parts of the stardard.
Demonstration applications are either real-world or contrived applications using standardised data to illustrate what the data could be used for. They can be used to demonstrate the advantages of using the standard at all, or using particular parts of the standard.

## Prioritisation Factors

Expand Down
2 changes: 1 addition & 1 deletion docs/components/developer_guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Describing the coding practices and workflows for contributing to the standard o

## Description

Developer guidelines set out the expectactions of external contributions to the standard or the tools that are provided to support adopters. They typically cover licensing, procedure for contributions to be reviewed, expectations around process, and technical expectations such as comments, naming conventions, tests and coding style.
Developer guidelines set out the expectations of external contributions to the standard or the tools that are provided to support adopters. They typically cover licensing, procedure for contributions to be reviewed, expectations around process, and technical expectations such as comments, naming conventions, tests and coding style.

## Prioritisation Factors

Expand Down
2 changes: 1 addition & 1 deletion docs/components/example_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Adopters of the standard and users of the data are often helped by seeing exampl
## Prioritisation Factors

- If the standard is large or complicated
- If adopters or users are often misunderstanding the requirements of the standard or strugging to 'get it'
- If adopters or users are often misunderstanding the requirements of the standard or struggling to 'get it'

## Deprioritisation Factors

Expand Down
2 changes: 1 addition & 1 deletion docs/components/getting_started_documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ User-friendly and filled with examples.

## Description

The normative documentation for standards is technical, prescise, authoratitive and comprehensive. While this is useful for a reference, the process of learning about a new standard is helped by the same kind of learning resources as any other learning process, including worked examples, guided learning through the standard, and practice materials.
The normative documentation for standards is technical, precise, authoritative and comprehensive. While this is useful for a reference, the process of learning about a new standard is helped by the same kind of learning resources as any other learning process, including worked examples, guided learning through the standard, and practice materials.

## Prioritisation Factors

Expand Down
2 changes: 1 addition & 1 deletion docs/components/icons.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Icons help with recall of key concepts, and consistency across a range of assets

## Prioritisation Factors

- If a standard is being discussed across media (eg in print, online and in person)
- If a standard is being discussed across media (e.g. in print, online and in person)
- If the standard is being translated
- If the standard introduces concepts unfamiliar to typical adopters
- If the standard is being discussed across policy and technical boundaries
Expand Down
4 changes: 2 additions & 2 deletions docs/components/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

On reviewing a range of policy-related data standards, including those that we maintain and those maintained by others, we identified approximately 60 components that at least two standards have chosen to create or adopt.

Whether or not these are important to a particular standard depends on lots of factors, including but not limited to the maturity of the standard, whether the standards adoption is being driven co-operatively or adversarially, political factors and the character of the people and organisations in the domain where the standard operates.
Whether or not these are important to a particular standard depends on lots of factors, including but not limited to the maturity of the standard, how the standard's adoption is being driven, political factors and the character of the people and organisations in the domain where the standard operates.

We conducted an exercise with representatives of several standards, asking them to conduct a diamond ranking exercise of the components. Diamond ranking was chosen to allow a ‘fat middle’ while forcing a decision on the highest and lowest priority items. Participants were asked to consider a standard at different levels of maturity, using Charles Handy’s Second Curve model for describing maturity.

Expand Down Expand Up @@ -89,4 +89,4 @@ glob:
hidden:
---
*
```
```
2 changes: 1 addition & 1 deletion docs/components/logo.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ A logo for the standard

## Description

A logo helps to reinforce the brand of the standard, gives a visual cue for recognition in resources, and can be used (with permission) by adoptors to demonstrate their use of the standard
A logo helps to reinforce the brand of the standard, gives a visual cue for recognition in resources, and can be used (with permission) by adopters to demonstrate their use of the standard

## Prioritisation Factors

Expand Down
2 changes: 1 addition & 1 deletion docs/components/recommended_data_license.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ E.g. the requirement that publishers should use Creative Commons or Open Databas

## Description

A recommended license can help to ensure that adopters give due consideration to licensing, as well as setting a high bar for adopters and encouraging intertia among the community using the standard.
A recommended license can help to ensure that adopters give due consideration to licensing. Clearly and openly licensed data encourages data use by the wider community.

## Prioritisation Factors

Expand Down
2 changes: 1 addition & 1 deletion docs/components/reference_lists.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

## Summary

Lookup lists for key concepts (e.g. organization registers).
Lookup lists for key concepts (e.g. organisation registers).


2 changes: 1 addition & 1 deletion docs/components/spreadsheet_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

## Summary

An editorialised template that can be filled in to provide data that meets the standard (Excel / AirTable etc.)
An editorialised template that can be filled in to provide data that meets the standard (Excel / Airtable etc.)


4 changes: 2 additions & 2 deletions docs/components/validator.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ For more information about how schema validation relates to additional checks, s

## Prioritisation Factors

* Specific error reporting and user expreience: If implementers need context-specific error messages and guidance, target feedback or multiple output formats (e.g. human-readable reports and machine-readable JSON for integration with other tools).
* Specific error reporting and user experience: If implementers need context-specific error messages and guidance, target feedback or multiple output formats (e.g. human-readable reports and machine-readable JSON for integration with other tools).
* Complexity beyond the schema language: If the standard involves additional rules that cannot be expressed in its schema language, validation of codelists specified outside the schema, or semantic validation of the data beyond its structure and format.

## Deprioritisation Factors
Expand All @@ -33,4 +33,4 @@ The Open Contracting Data Standard (OCDS) provides a web-based validator (the [O

## Related patterns

* [Permissive schema](../patterns/schema.md#permissive-schema)
* [Permissive schema](../patterns/schema.md#permissive-schema)
2 changes: 1 addition & 1 deletion docs/development/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Sphinx has the ability to process and integrate documentation from different sou

We have created a number of [custom directives documented here](https://github.com/OpenDataServices/sphinxcontrib-opendataservices).

[reStructuredText](http://docutils.sourceforge.net/rst.html) is the native input format for Sphinx builds. However, with the bridge library recommommark, it is possible to use input files in Markdown.
[reStructuredText](http://docutils.sourceforge.net/rst.html) is the native input format for Sphinx builds. However, with the bridge library [recommonmark](https://recommonmark.readthedocs.io/en/latest/index.html), it is possible to use input files in Markdown.

We maintain a custom [sphinx-base](https://github.com/OpenDataServices/sphinx-base) project to use when starting new documentation sites.

Expand Down
Loading