Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use shared code, and fix a variety of issues #121

Merged
merged 47 commits into from Apr 23, 2018
Merged

Use shared code, and fix a variety of issues #121

merged 47 commits into from Apr 23, 2018

Conversation

jpmckinney
Copy link
Member

@jpmckinney jpmckinney commented Mar 21, 2018

I started this PR to use a common build across profiles, but ended up finding and fixing a variety of issues along the way:

  • tag enum not matching the changes to the releaseTag codelist
  • Line breaks inside codelist rows, without appropriate quoting
  • Invalid collapse values in jsonschema directives
  • A broken RST table in framework.md
  • Mis-capitalized or suffixed codelist headers
  • Blank lines in codelists
  • Inconsistent use of contract/implementation versus "contract, implementation" in documentType.csv Section column
  • Missing codelists property in extension.json
  • Typos in codes and fields in the documentation
  • Typos in documentation and codelist descriptions

The above issues would: affect (or break) the correct parsing of those codelists, mis-render (or not render) elements of the docs, and/or introduce ambiguity which could lead to errors in implementation. So, I think this is important to merge.

This PR also includes #63.

Use https://github.com/open-contracting/public-private-partnerships/pull/121/files?w=1 to ignore whitespace changes.

When reviewing the PR, you can skip all the following files using the "Jump to…" dropdown, as these are generated from other files (by copying or by script):

  • compiledCodelists (36 files)
  • docs/extensions (19 files), but don't skip milestones.md, which is not generated (index.md is also not generated, but it is unchanged)
  • docs/extensions/codelists (16 files)
  • schema/base-codelists (20 files)
  • schema/base-release-schema.json
  • schema/ppp-extension.json
  • schema/ppp-release-schema.json

Another 9 files are part of the build and not part of the docs, and don't require as close a review, as what matters is what gets built. Another 2 files are example files with typo and whitespace corrections.

So, that leaves only 20 substantive files to review, all of which are quite fast to review as the changes are minor (but sometimes important).

@jpmckinney jpmckinney mentioned this pull request Mar 22, 2018
@jpmckinney jpmckinney changed the title Update conf.py to use shared code Use shared code, and fix a variety of issues Mar 22, 2018
@jpmckinney
Copy link
Member Author

@duncandewhurst We can perhaps schedule a call to review; there are a lot of commits, but it shouldn't take to long to review on a call. Several other issues/PRs depend on merging this.

@jpmckinney
Copy link
Member Author

jpmckinney commented Apr 23, 2018

Approved PR with @duncandewhurst. The "latest" branch at http://standard.open-contracting.org/profiles/ppp/latest/ won't be affected as we still need to manually copy the built documentation, which we'll do after sorting translations.

@jpmckinney jpmckinney merged commit 8d1571f into master Apr 23, 2018
@jpmckinney jpmckinney deleted the confpy branch April 23, 2018 21:06
@jpmckinney jpmckinney added the bug label Jul 6, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant