Merge pull request #382 from open-contracting/support-wording-0.9

Updating wording from 0.9
open-contracting · Dec 16, 2022 · 73418bf · 73418bf
2 parents 787dca7 + 424cfce
commit 73418bf
Show file tree

Hide file tree

Showing 13 changed files with 142 additions and 118 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -5,30 +5,27 @@ jobs:
     if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           submodules: true
-      - uses: actions/setup-python@v1
+      - uses: actions/setup-python@v4
         with:
-          python-version: 3.6
-      - uses: actions/cache@v1
-        with:
-          path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
+          python-version: 3.8
+          cache: pip
+          cache-dependency-path: '**/requirements*.txt'
       # Don't install editable projects in the current working directory.
       # https://pip.pypa.io/en/latest/reference/pip_install/#install-src
       - run: pip install --src $GITHUB_WORKSPACE/../src -r requirements.txt
       # Google Chrome and ChromeDriver are already included.
       # https://help.github.com/en/actions/reference/software-installed-on-github-hosted-runners
+      # https://github.com/actions/virtual-environments/blob/main/images/linux/Ubuntu2004-Readme.md
       - if: github.repository == 'open-contracting/standard_profile_template'
         run: make update extract
       - run: make
       - run: |
           make linkcheck
-          rm -f output.json output.txt
-      - run: pytest
+          find . \( -name output.json -o -name output.txt \) -exec rm -r "{}" \;
+      - run: pytest -W error
       # Deploy the built documentation to the staging directory.
       - if: github.event_name == 'push'
         uses: shimataro/ssh-key-action@v2

diff --git a/.github/workflows/js.yml b/.github/workflows/js.yml
@@ -5,9 +5,9 @@ jobs:
     if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
         with:
-          node-version: 14.x
+          node-version: 16.x
       - run: npm install standard
       - run: npx standard docs/_static/json-example-format.js
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -7,19 +7,11 @@ jobs:
     if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v1
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
         with:
-          python-version: 3.6
-      - uses: actions/cache@v1
-        with:
-          path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('.github/workflows/lint.yml') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
+          python-version: 3.8
+          cache: pip
+          cache-dependency-path: '**/requirements*.txt'
       - run: curl -s -S --retry 3 $BASEDIR/tests/install.sh | bash -
-      - run: sudo apt-get install shellcheck
-      - run: sudo snap install shfmt
       - run: curl -s -S --retry 3 $BASEDIR/tests/script.sh | bash -
-      - run: shellcheck $(shfmt -f .)
-      - run: shfmt -d -i 4 -sr $(shfmt -f .)
diff --git a/.github/workflows/shell.yml b/.github/workflows/shell.yml
@@ -0,0 +1,15 @@
+name: Lint Shell
+on: [push, pull_request]
+jobs:
+  build:
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install shellcheck
+        run: |
+          sudo apt update
+          sudo apt install shellcheck
+      - run: sudo snap install shfmt
+      - run: shellcheck $(shfmt -f .)
+      - run: shfmt -d -i 4 -sr $(shfmt -f .)
diff --git a/common-requirements.txt b/common-requirements.txt
@@ -1,5 +1,5 @@
 #
-# This file is autogenerated by pip-compile
+# This file is autogenerated by pip-compile with python 3.8
 # To update, run:
 #
 #    pip-compile common-requirements.in
@@ -8,18 +8,27 @@
     # via -r common-requirements.in
 alabaster==0.7.12
     # via sphinx
+async-generator==1.10
+    # via
+    #   trio
+    #   trio-websocket
 attrs==20.3.0
     # via
     #   markdown-it-py
+    #   outcome
     #   pytest
-babel==2.9.0
+    #   trio
+babel==2.9.1
     # via
     #   sphinx
     #   sphinx-intl
 certifi==2020.12.5
     # via
     #   elasticsearch
     #   requests
+    #   urllib3
+cffi==1.15.0
+    # via cryptography
 chardet==4.0.0
     # via requests
 click==7.1.2
@@ -30,25 +39,31 @@ click==7.1.2
     #   sphinx-intl
 colorama==0.4.4
     # via sphinx-autobuild
+cryptography==36.0.2
+    # via
+    #   pyopenssl
+    #   urllib3
 docutils==0.16
     # via
     #   myst-parser
     #   sphinx
 elasticsearch==7.11.0
     # via ocdsindex
+exceptiongroup==1.0.0
+    # via pytest
 gitdb==4.0.5
     # via gitpython
 gitpython==3.1.14
     # via transifex-client
+h11==0.13.0
+    # via wsproto
 idna==2.10
-    # via requests
+    # via
+    #   requests
+    #   trio
+    #   urllib3
 imagesize==1.2.0
     # via sphinx
-importlib-metadata==3.7.3
-    # via
-    #   pep517
-    #   pluggy
-    #   pytest
 iniconfig==1.1.1
     # via pytest
 jinja2==2.11.3
@@ -57,13 +72,13 @@ jinja2==2.11.3
     #   sphinx
 json-merge-patch==0.2
     # via ocdsextensionregistry
-jsonref==0.2
+jsonref==1.0.0.post1
     # via ocdsextensionregistry
 linkify-it-py==1.0.1
     # via -r common-requirements.in
 livereload==2.6.3
     # via sphinx-autobuild
-lxml==4.6.3
+lxml==4.7.1
     # via ocdsindex
 markdown-it-py==1.0.0
     # via
@@ -77,62 +92,72 @@ myst-parser==0.15.1
     # via -r common-requirements.in
 ocds-babel==0.3.1
     # via -r common-requirements.in
-ocdsextensionregistry==0.1.3
+ocdsextensionregistry==0.1.12
     # via -r common-requirements.in
 ocdsindex==0.0.7
     # via -r common-requirements.in
+outcome==1.1.0
+    # via trio
 packaging==20.9
     # via
     #   pytest
     #   sphinx
 pep517==0.10.0
     # via pip-tools
-pip-tools==6.0.1
+pip-tools==6.6.0
     # via -r common-requirements.in
 pluggy==0.13.1
     # via pytest
-py==1.10.0
-    # via pytest
+pycparser==2.21
+    # via cffi
 pygments==2.8.1
     # via sphinx
+pyopenssl==22.0.0
+    # via urllib3
 pyparsing==2.4.7
     # via packaging
-pytest==6.2.2
+pysocks==1.7.1
+    # via urllib3
+pytest==7.2.0
     # via -r common-requirements.in
 python-slugify==4.0.1
     # via transifex-client
 pytz==2021.1
     # via babel
 pyyaml==5.4.1
     # via myst-parser
-requests-cache==0.5.2
-    # via ocdsextensionregistry
 requests==2.25.1
     # via
     #   ocdsextensionregistry
     #   requests-cache
     #   sphinx
     #   transifex-client
-selenium==3.141.0
+requests-cache==0.5.2
+    # via ocdsextensionregistry
+selenium==4.1.3
     # via -r common-requirements.in
 six==1.15.0
     # via
     #   livereload
     #   transifex-client
 smmap==3.0.5
     # via gitdb
+sniffio==1.2.0
+    # via trio
 snowballstemmer==2.1.0
     # via sphinx
-sphinx-autobuild==2021.3.14
-    # via -r common-requirements.in
-sphinx-intl==2.0.1
-    # via -r common-requirements.in
+sortedcontainers==2.4.0
+    # via trio
 sphinx==3.5.2
     # via
     #   -r common-requirements.in
     #   myst-parser
     #   sphinx-autobuild
     #   sphinx-intl
+sphinx-autobuild==2021.3.14
+    # via -r common-requirements.in
+sphinx-intl==2.0.1
+    # via -r common-requirements.in
 sphinxcontrib-applehelp==1.0.2
     # via sphinx
 sphinxcontrib-devhelp==1.0.2
@@ -148,29 +173,31 @@ sphinxcontrib-serializinghtml==1.1.4
 text-unidecode==1.3
     # via python-slugify
 toml==0.10.2
-    # via
-    #   pep517
-    #   pytest
+    # via pep517
+tomli==2.0.1
+    # via pytest
 tornado==6.1
     # via livereload
 transifex-client==0.14.2
     # via -r common-requirements.in
-typing-extensions==3.7.4.3
+trio==0.20.0
     # via
-    #   importlib-metadata
-    #   markdown-it-py
+    #   selenium
+    #   trio-websocket
+trio-websocket==0.9.2
+    # via selenium
 uc-micro-py==1.0.1
     # via linkify-it-py
-urllib3==1.26.5
+urllib3[secure,socks]==1.26.5
     # via
     #   elasticsearch
     #   requests
     #   selenium
     #   transifex-client
-zipp==3.4.1
-    # via
-    #   importlib-metadata
-    #   pep517
+wheel==0.37.0
+    # via pip-tools
+wsproto==1.1.0
+    # via trio-websocket
 
 # The following packages are considered to be unsafe in a requirements file:
 # pip

diff --git a/docs/conf.py b/docs/conf.py
@@ -77,7 +77,8 @@
 
 # Internationalization.
 gettext_compact = False
-gettext_domain_prefix = '{}-'.format(profile_identifier)  # `DOMAIN_PREFIX` from `config.mk`
+# `DOMAIN_PREFIX` from `config.mk`.
+gettext_domain_prefix = f'{profile_identifier}-' if profile_identifier else ''
 locale_dirs = ['locale/', os.path.join(standard_theme.get_html_theme_path(), 'locale')]
 # We use single quotes for codes, which docutils will change to double quotes.
 # https://sourceforge.net/p/docutils/code/HEAD/tree/trunk/docutils/docutils/utils/smartquotes.py
@@ -98,19 +99,19 @@
 html_theme_options = {
     'analytics_id': 'YEWDOOEQ',
     'display_version': True,
-    'root_url': '/{}'.format(profile_identifier),
+    'root_url': f'/{profile_identifier}' if profile_identifier else '',
     'short_project': project.replace('Open Contracting Data Standard', 'OCDS'),
     'copyright': copyright,
     'license_name': 'Apache License 2.0',
-    'license_url': '{}/blob/HEAD/LICENSE'.format(repository_url),
+    'license_url': f'{repository_url}/blob/HEAD/LICENSE',
     'repository_url': repository_url,
 }
 
 
 def setup(app):
     # The root of the repository.
     basedir = Path(__file__).resolve().parents[1]
-    # The `LOCALE_DIR` from `config.mk`.
+    # `LOCALE_DIR` from `config.mk`.
     localedir = basedir / 'docs' / 'locale'
 
     language = app.config.overrides.get('language', 'en')
@@ -121,11 +122,11 @@ def setup(app):
     mapping_headers = ['Mapping to OC4IDS', 'Mapping from OCDS']
 
     # The gettext domain for schema translations. Should match the domain in the `pybabel compile` command.
-    schema_domain = '{}schema'.format(gettext_domain_prefix)
+    schema_domain = f'{gettext_domain_prefix}schema'
     # The gettext domain for codelist translations. Should match the domain in the `pybabel compile` command.
-    codelists_domain = '{}codelists'.format(gettext_domain_prefix)
+    codelists_domain = f'{gettext_domain_prefix}codelists'
     # The gettext domain for mapping translations. Should match the domain in the `pybabel compile` command.
-    mapping_domain = '{}mappings'.format(gettext_domain_prefix)
+    mapping_domain = f'{gettext_domain_prefix}mappings'
 
     schema_dir = basedir / 'schema' / 'project-level'
     static_dir = basedir / 'docs' / '_static' / 'project-level'

diff --git a/docs/reference/changelog.md b/docs/reference/changelog.md
@@ -21,6 +21,7 @@
 * [#260](https://github.com/open-contracting/infrastructure/pull/260) - improve the clarity of the Getting Started documentation.
 * [#329](https://github.com/open-contracting/infrastructure/pull/329) - fix incorrect references to `document.type` in the CoST IDS & OCDS mapping.
 * [#339](https://github.com/open-contracting/infrastructure/pull/339) - update link to CoST IDS on mapping page.
+* [#382](https://github.com/open-contracting/infrastructure/pull/382) - update email addresses for support.
 
 ### Schema
 

diff --git a/docs/support.md b/docs/support.md
@@ -1,20 +1,21 @@
 # Support
 
-If you are planning to publish or use data using the OC4IDS then the OC4IDS Helpdesk team are on hand to offer advice and input.
+If you are planning to publish or use data using the OC4IDS then the Open Contracting Partnership and CoST - the Infrastructure Transparency Initiative can provide free-of-charge support.
 
 We can:
 
 * Help you identify approaches for converting data from your existing systems to OC4IDS;
-* Suggest existing tools and services which may help you publish or use OC4IDS data;
+* Suggest existing tools and services which might help you publish or use OC4IDS data;
 * Provide guidance on mapping your data structures to the standard;
 * Give you feedback on draft data files, and support with validation of your data;
 
-Through funding from the Open Contracting Partnership and CoST - the Infrastructure Transparency Initiative, this support is provided free of charge.
+Use the following email addresses to request support:
 
-E-mail [data@open-contracting.org](mailto:data@open-contracting.org) with your questions, and a member of the OC4IDS Helpdesk will be in touch with you soon.
+* [opencode@infrastructuretransparency.org](mailto:opencode@infrastructuretransparency.org) for support from CoST - the Infrastructure Transparency Initiative
+* [data@open-contracting.org](mailto:data@open-contracting.org) for support from the Open Contracting Partnership.
 
 ```{admonition} Contributing
 :class: hint
 
-Developers, or those wishing to provide technical input to OC4IDS, may wish to go straight to the [GitHub repository](https://github.com/open-contracting/infrastructure).
+Developers, or those wishing to provide technical input to OC4IDS, can go straight to the [GitHub repository](https://github.com/open-contracting/infrastructure).
 ```