Skip to content

Latest commit

 

History

History
36 lines (27 loc) · 1.34 KB

README.md

File metadata and controls

36 lines (27 loc) · 1.34 KB
Raw

OCDS Profile Template

Getting started

  1. Create a repository from this template
  2. Configure the repository
  3. Clone the repository
  4. Replace TODO in .github/workflows/ci.yml, docs/conf.py, docs/index.md, schema/profile/extension.json
  5. Replace the content of the readme with Read this profile at <https://standard.open-contracting.org/profiles/TODO/latest/en/>
  6. Commit your changes
  7. Configure robots.txt to allow access to the profile's documentation

Updating build-related files

Periodically update the stable files across the standard and profiles:

./script/update

Periodically compare the configurable files to the template's files:

./script/diff

Notes

  • The .tx/config file was generated by sphinx-intl create-txconfig
  • The docs/conf.py file was generated by sphinx-quickstart with the non-default answers:
    • Root path for the documentation: docs
    • Project name: Open Contracting Data Standard for TODO
    • Author name(s): Open Contracting Partnership
    • Project version: 1.0
    • Project release: 1.0.0-rc.1
    • Source file suffix: .md