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
Add schema browser #209
Add schema browser #209
Conversation
docs/example.md
Outdated
@@ -19,11 +19,11 @@ We used the [spreadsheet template](spreadsheet.md) to prepare a series of releas | |||
|
|||
This was exported as an Excel file, and converted into JSON using the [OCDS Convert, Validate and Explore tool](http://standard.open-contracting.org/validator/) | |||
|
|||
The release were then compiled into a record, and are available to browse using the [open source OCDS Show framework](https://github.com/open-contracting/ocds-show/tree/ppp) which provides: | |||
The release were then compiled into a record, and are available to browse using the [open source OCDS Show framework](https://github.com/open-contracting/ocds-show/) which provides: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the two links should be to OCDS Show for PPPs, right? https://github.com/open-contracting/ocds-show-ppp I prefer to hyperlink only the words "OCDS Show" and change "framework" to "tool" as it's not clear to me how it is a framework.
Should there be a link to the deployed app? https://open-contracting.github.io/ocds-show-ppp/
release -> releases
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the two links should be to OCDS Show for PPPs, right?
My understanding is that the OCDS Show for PPPs repo only exists so that there can be Github pages deployments of both versions.
The main OCDS show repo includes templates for the PPP schema (just not the theme and different title in the deployed version) and there is more comprehensive documentation in the readme, so I think it's best to link to that one.
Maybe we should add a link from the main OCDS-show readme to the OCDS-show for PPPs repo though?
Should there be a link to the deployed app? https://open-contracting.github.io/ocds-show-ppp/
There is a link to the version deployed as part of the profile, with the example data loaded into it, under the next heading ('Explore the example'). Was there a particular reason to also provide a link to the (empty) Github pages version?
I've addressed the other points in 6bf3ebe
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(1) There is a link to OCDS Show from OCDS Show for PPPs, but feel free to suggest changes to make this more clear and the readme more helpful.
I think it's confusing for someone wanting to run a copy of OCDS Show for PPPs to be directed to OCDS Show, which by default doesn't use the PPP templates (they are in the repository, but not used by that app without changes). To use the PPP templates, the user at minimum needs to change index.html, specifically: change record_release.html to record_release_ppp.html, change release.html to release_ppp.html, and uncomment social witness code.
This is not obvious and is extra effort compared to using the repo that already has those changes made.
(2) Presently, the situation is:
- Make changes to OCDS Show base templates
- Copy those to the PPP templates in OCDS Show
- Copy all changes to OCDS Show for PPPs
- Copy all changes to OCDS for PPPs profile
This is a lot of steps, and different people at different times have forgotten that this is what is required, and so, for example:
- David and Bibiana made changes to base templates, but …
- … without copying to PPP templates. Insert extra fields in templates open-contracting/ocds-show#30
- None of those changes were copied to OCDS Show for PPPs.
- You made changes to the copy in the profile, which would be overwritten the next time we pulled in a copy. Update extension url #178
I've made mistakes, too, and this is just a subset of the more times we have forgotten the process. (I recently cleared up the last of the inconsistencies.)
Clearly, this is overly complicated. Instead of a link like:
../_static/ocds-show/?load=../full_record_package.json
It can be:
https://open-contracting.github.io/ocds-show-ppp/?load=https://standard.open-contracting.org/profiles/ppp/latest/en/_static/full_record_package.json
In which case we no longer need a local copy, eliminating the 4th step. To do that, we'd need to set CORS headers on the standard documentation server.
The 2nd step is the subject of open-contracting/ocds-show#38. The 3rd step is the subject of open-contracting/ocds-show#39
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If those changes are made, we'll also need to change the update_ocds_show
make command. Basically: trim it down to just update docs/examples
by curl
'ing the two files from the ocds-show-ppp repository. Then, update the readme accordingly.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Anyhow, we can do those further steps as part of #211
To clarify, let's just do my point (1) in this PR (linking to OCDS Show for PPPs instead of OCDS Show). We can do the point (2) in #211. |
I've addressed point (1) - let me know when you're happy for this to be merged. |
I added a bit more context on the OCDS Show for PPPs repo, to help reusers and to direct them to OCDS Show for additional docs. |
Merge once #203 merged
Closes #187