Bytemark

Bytemark hosts the OCDS documentation (described below) and:

Bytemark, under Open Data Services’ account, hosts dev.cove.opendataservices.coop for the development version of the OCDS Data Review Tool. This server is also used for other ODS clients.

OCDS Documentation

  • live.docs.opencontracting.uk0.bigv.io serves released documentation of the OCDS (e.g. 1.1) and its profiles (e.g. Public Private Partnerships). It is also a reverse proxy to:
    • live.cove.opencontracting.uk0.bigv.io (mentioned above)
    • cove-live.oc4ids.opencontracting.uk0.bigv.io (mentioned above)
    • staging.docs.opencontracting.uk0.bigv.io
  • staging.docs.opencontracting.uk0.bigv.io serves draft documentation of the OCDS and its profiles. If necessary, it can be browsed directly.
  • live.standard-search.opencontracting.uk0.bigv.io serves the Search API, whose base URL is http://standard-search.open-contracting.org/v1.

Version and language switchers

The version switcher links to a /switcher URL path with a branch URL parameter. The language switcher links to a /{version}/switcher URL path with a lang URL parameter. These are redirected by Apache (you can search for /switcher in its config files).

Search API

The search.js file in the standard_theme repository sends an unauthenticated request to the API’s /search endpoint to retrieve search results.

The Travis deploy script in this repository sends an authenticated request to the API’s /index_ocds endpoint to index the documentation for the OCDS and its profiles.

Travis

The repositories for OCDS documentation use Travis to push builds to the staging server and to rebuild the search index for the documentation:

  • Each branch of the standard repository is automatically built to:

    https://standard.open-contracting.org/{branch}/en/
    
  • Each branch of a profile’s repository is automatically built to:

    https://standard.open-contracting.org/profiles/{root}/{branch}/en/
    

In detail, the repositories use script deployment to run deploy-docs.sh in this repository. For this script to succeed, Travis must be configured to have access to the staging server and to the Search API’s /index_ocds endpoint.