Skip to content

Commit 3b28453

Browse files
authored
Merge pull request #41 from OpenDataServices/various-improvements
Various improvements
2 parents e64cc74 + f0efd14 commit 3b28453

35 files changed

+868
-2592
lines changed

.github/workflows/linkcheck.yml

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,14 @@ on: [push, pull_request]
33

44
jobs:
55
linkcheck:
6-
# We need an old Ubuntu to get Python 3.6
7-
runs-on: ubuntu-20.04
6+
runs-on: ubuntu-24.04
87
steps:
9-
- uses: actions/checkout@v2
8+
- uses: actions/checkout@v4
109
- name: Setup python
11-
uses: actions/setup-python@v2
10+
uses: actions/setup-python@v5
1211
with:
13-
python-version: 3.6
12+
python-version: 3.13
1413
architecture: x64
15-
- uses: actions/cache@v1
16-
with:
17-
path: ~/.cache/pip
18-
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
1914
- run: pip install -r requirements.txt
2015
- run: cd ./docs/ && make dirhtml
2116
- run: cd ./docs/ && make linkcheck

.readthedocs.yaml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Read the Docs configuration file
2+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
4+
# Required
5+
version: 2
6+
7+
# Set the OS, Python version, and other tools you might need
8+
build:
9+
os: ubuntu-24.04
10+
tools:
11+
python: "3.13"
12+
13+
# Build documentation in the "docs/" directory with Sphinx
14+
sphinx:
15+
configuration: docs/conf.py
16+
17+
# Optionally, but recommended,
18+
# declare the Python requirements required to build your documentation
19+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
20+
python:
21+
install:
22+
- requirements: requirements.txt
23+
24+

README.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ Services docs projects.
1313
* Internationalisation
1414
* Wrapping text in tables, to avoid having horizontal scrollbars
1515

16-
1716
## Building the documentation
1817

1918
### Build the docs locally
@@ -42,7 +41,6 @@ make dirhtml
4241

4342
Built docs are in `docs/_build/dirhtml`.
4443

45-
4644
Viewing the docs:
4745
```
4846
cd _build/dirhtml
@@ -51,7 +49,6 @@ python -m http.server
5149

5250
Then go to http://localhost:8000/ in a browser.
5351

54-
5552
### Building on readthedocs
5653

5754
* Select your repo at: https://readthedocs.org/dashboard/import/

docs/about/index.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,18 @@
11
# About us
22

3-
```eval_rst
4-
.. _our-services:
5-
```
6-
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.
3+
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.
84

95
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.
106

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

13-
* **Software development** - creating re-usable open source code that helps us to do our work, and that supports the documentation, implementation and demonstration of open data standards;
14-
* **Analysis and implementation support** - working with policy initiatives, governments, non-profits and companies to equip them to publish and use open data with one of the standards we support;
15-
* **Research and development** - supporting the development of new open data standards;
16-
* **Training and consultancy** - addressing issues of policy and organisational change.
9+
- **Software development** - creating re-usable open source code that helps us to do our work, and that supports the documentation, implementation and demonstration of open data standards;
10+
- **Analysis and implementation support** - working with policy initiatives, governments, non-profits and companies to equip them to publish and use open data with one of the standards we support;
11+
- **Research and development** - supporting the development of new open data standards;
12+
- **Training and consultancy** - addressing issues of policy and organisational change.
1713

18-
We operate as a non-hierarchical worker-owned business, committed to [co-operative principles and values](https://ica.coop/en/whats-co-op/co-operative-identity-values-principles), and to using our resources in order to provide a good place to work, to develop our staff, and to contribute to the wider community.
14+
We operate as a non-hierarchical worker-owned business, committed to [co-operative principles and values](https://ica.coop/en/whats-co-op/co-operative-identity-values-principles), and to using our resources in order to provide a good place to work, to develop our staff, and to contribute to the wider community.
1915

20-
We are primarily funded through short and long-term contracts to research, develop and support implementation of open data standards.
16+
We are primarily funded through short and long-term contracts to research, develop and support implementation of open data standards.
2117

2218
To find out more about working with us on an open data standards project, get in touch with [[email protected]](mailto:[email protected])

docs/adoption/helpdesk.md

Lines changed: 18 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -30,45 +30,38 @@ When individual implementers feel like they are part of a wider community, and f
3030

3131
Often the questions asked in private would make for good public discussions. A helpdesk team can translate individual implementation issues into wider forum or issue-tracker posts, and can bring together the different stakeholders who may have views on those issues. Making connections between implementers, and working to align data publishers and users, can make a difference to the success of implementations.
3232

33-
Policy actors seek compliance with a standard. Users seek data usability.
33+
Policy actors seek compliance with a standard. Users seek data usability.
3434
This is a tension to manage. A helpdesk should keep in mind the overall policy goals of a standard, whilst also ensuring the technical correctness of implementations.
3535

3636
**Standards are always developing**
3737

38-
The documentation will have gaps. A standard will not cater for all use cases. The helpdesk are able to identify gaps, and identify ways to address them through improved resources, or by feeding into the development of schemes and related tools.
38+
The documentation will have gaps. A standard will not cater for all use cases. The helpdesk is able to identify gaps, and identify ways to address them through improved resources, or by feeding into the development of schemes and related tools.
3939

4040
A lot of the engagements a helpdesk has can be light-touch: aiming to provide quick replies to simple questions, to help keep implementations moving. In some cases, helpdesk engagements may be more in-depth, involving multiple days of work to support an implementer in planning, executing or evaluating their data publication.
4141

4242
## What?
43+
4344
A helpdesk might have the following modalities of work:
4445

45-
* **Fielding direct enquiries** - with an e-mail address, twitter handle and instant messages going into a ticketing system, from which written replies can be sent, and through which management information on the types of enquiries and enquirers getting in touch can be logged. Enquiries may come direct from implementers, or may come from the advocacy partners seeking to promote adoption of the standard.
46-
* **Scoping notes** - working with prospective implementers to develop a shared understand of where the standard could help, and to identify options and steps for adoption;
47-
* **Mapping reviews** - providing templates to map existing systems to the standard, and reviewing implementer produced mappings.
48-
* **Implementation guidance** - sharing suggestions, resources and examples to highlight relevant technical and policy approaches to implementation.
49-
* **Data review and quality assurance** - performing automated and manual checks on data quality.
50-
* **Training** - delivering online and face-to-face training to implementers, and to other support providers, as part of capacity and field building.
51-
* **Tool assessment** - reviewing open source tools developed to work with the standard and providing assessments of their re-usability.
52-
* **Technical analysis for policy advocates** - acting as a sounding board for policy and advocacy teams, to help assess the extent to which a technical implementation will meet policy goals.
53-
* **Knowledge management** - keeping track of prospective and actual implementations, and supporting reporting about levels of engagement with the standard.
46+
- **Fielding direct enquiries** - with an e-mail address, twitter handle and instant messages going into a ticketing system, from which written replies can be sent, and through which management information on the types of enquiries and enquirers getting in touch can be logged. Enquiries may come direct from implementers, or may come from the advocacy partners seeking to promote adoption of the standard.
47+
- **Scoping notes** - working with prospective implementers to develop a shared understanding of where the standard could help, and to identify options and steps for adoption;
48+
- **Mapping reviews** - providing templates to map existing systems to the standard, and reviewing implementer produced mappings.
49+
- **Implementation guidance** - sharing suggestions, resources and examples to highlight relevant technical and policy approaches to implementation.
50+
- **Data review and quality assurance** - performing automated and manual checks on data quality.
51+
- **Training** - delivering online and face-to-face training to implementers, and to other support providers, as part of capacity and field building.
52+
- **Tool assessment** - reviewing open source tools developed to work with the standard and providing assessments of their re-usability.
53+
- **Technical analysis for policy advocates** - acting as a sounding board for policy and advocacy teams, to help assess the extent to which a technical implementation will meet policy goals.
54+
- **Knowledge management** - keeping track of prospective and actual implementations, and supporting reporting about levels of engagement with the standard.
5455

5556
## Examples
5657

57-
* The International Aid Transparency Initiative provides a helpdesk service that receives around 110 monthly support requests, as of November 2017). A number of other providers also offer support to particular segments of the implementing community (e.g UK NGOs)
58-
59-
* The [Open Contracting Data Standard helpdesk](http://standard.open-contracting.org/latest/en/support/) provides e-mail support, as well as working closely with the Open Contracting Partnership to identify adopters for priority support and outreach. The OCDS helpdesk is run by two partner organisations: Open Data Services Co-operative, and ILDA, who cover support for Latin America.
60-
58+
- The International Aid Transparency Initiative provides a helpdesk service that receives around 110 monthly support requests, as of November 2017). A number of other providers also offer support to particular segments of the implementing community (e.g. UK NGOs)
6159

62-
```eval_rst
63-
.. todo::
64-
65-
.. markdown::
60+
- The [Open Contracting Data Standard helpdesk](http://standard.open-contracting.org/latest/en/support/) provides e-mail support, as well as working closely with the Open Contracting Partnership to identify adopters for priority support and outreach. The OCDS helpdesk is run by two partner organisations: Open Data Services Co-operative, and ILDA, who cover support for Latin America.
6661

67-
## Components
68-
69-
A helpdesk makes use of some of the following components:
70-
71-
TODO: Add a list of components
62+
```{seealso}
63+
Components:
7264
65+
* [Helpdesk email address](../components/index.md#helpdesk-email-address)
66+
* [Helpdesk phone number](../components/index.md#helpdesk-phone-number)
7367
```
74-

docs/adoption/index.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
11
# Adoption
22

3-
The success of an open data standard rests on its adoption. A standard with no users is hardly a standard at all. However, depending on the nature of a standard, there may be different approaches to successful adoption.
3+
The success of an open data standard rests on its adoption. A standard with no users is hardly a standard at all. However, depending on the nature of a standard, there may be different approaches to successful adoption.
44

55
This section considers **the adoption curve**, different **kinds of adopters**, and different strategies to support adoption.
66

7-
8-
```eval_rst
9-
.. toctree::
10-
:maxdepth: 2
11-
:glob:
12-
13-
theory_and_practice
14-
journey
15-
helpdesk
7+
```{toctree}
8+
---
9+
maxdepth: 2
10+
glob:
11+
---
12+
theory_and_practice
13+
journey
14+
helpdesk
1615
1716
```

docs/adoption/journey.md

Lines changed: 19 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,42 @@
11
# The adoption journey
22

3-
Adopting a policy related open data standard is generally a multi stage process.
3+
Adopting a policy related open data standard is generally a multi-stage process.
44

55
The Open Contracting Data Standard uses the [7-step model below to describe the process of data standard implementation](https://www.open-contracting.org/implement/#/) within the context of wider adoption of open contracting principles and practices.
66

77
![](/_static/images/OCDS-implement.png)
88

99
360Giving [describe a five-step data publication process](http://www.threesixtygiving.org/support/publish-data/).
1010

11-
```eval_rst
12-
.. admonition:: For example
13-
:class: note
14-
15-
.. markdown::
16-
17-
The five steps for 360Giving data publication are:
18-
19-
1. Discuss and plan
20-
1. Select your publishing template
21-
1. Prepare your data
22-
1. Publish on your website
23-
1. Register with 360Giving
24-
11+
```{admonition} Example
12+
---
13+
class: note
14+
---
15+
The five steps for 360Giving data publication are:
16+
17+
1. Discuss and plan
18+
1. Select your publishing template
19+
1. Prepare your data
20+
1. Publish on your website
21+
1. Register with 360Giving
2522
```
2623

2724
At a more general level, we think about four stages of adoption, arranged as part of an ongoing cycle:
2825

2926
![](/_static/images/adoption-stages.png)
3027

31-
### Commit
28+
## Commit
3229

33-
For policy related open data standards there will often be a process for securing commitments to adopt. This might come through resolutions or motions, through public announcements, or through getting organisations to sign up to a pledge of some form. Commitments are vital to (a) understand the goals of the implementer, and align implementation with those goals; (b) help overcome technical or bureaucratic barriers that might get in the way of adoption.
30+
For policy related open data standards there will often be a process for securing commitments to adopt. This might come through resolutions or motions, through public announcements, or through getting organisations to sign up to a pledge of some form. Commitments are vital to (a) understand the goals of the implementer, and align implementation with those goals; (b) help overcome technical or bureaucratic barriers that might get in the way of adoption.
3431

35-
### Map
32+
## Map
3633

37-
In general, the data to be represented through a standard already exists in some system, or systems that *could* collect it exist. The mapping stage addresses the systems and business processes that will need to change to produce or consume standardised data, as well as look at the level of individual data elements to agree how data will be represented or consumed.
34+
In general, the data to be represented through a standard already exists in some system, or systems that *could* collect it exist. The mapping stage addresses the systems and business processes that will need to change to produce or consume standardised data, as well as look at the level of individual data elements to agree how data will be represented or consumed.
3835

39-
### Build
36+
## Build
4037

4138
At this stage the process and systems to create or consume standardised data are created. There may need to be a few iterations here to get something that produces data of adequate quality.
4239

43-
### Evaluate
40+
## Evaluate
4441

45-
One of the structural features of **open** data, is that it is often shared *before* it is used. This can mean that problems with the data are not picked up straight away, but instead are identified when someone first comes to analyse it, maybe weeks or months after the 'build' stage is complete. This is why early **review** or **evaluation** of data and data quality is vital to building a sustainable open data ecosystem. This might be manual review of data, or might come through the availability of tools that can be used to review the data resulting from the build stage (e.g. [Online Validator](component-online-validator) or [Quality Tool](component-quality-tool)).
42+
One of the structural features of **open** data, is that it is often shared *before* it is used. This can mean that problems with the data are not picked up straight away, but instead are identified when someone first comes to analyse it, maybe weeks or months after the 'build' stage is complete. This is why early **review** or **evaluation** of data and data quality is vital to building a sustainable open data ecosystem. This might be manual review of data, or might come through the availability of tools that can be used to review the data resulting from the build stage (e.g. [Online Validator](../components/index.md#online-validator) or [Quality Tool](../components/index.md#quality-tool)).

0 commit comments

Comments
 (0)