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

META: Have examples in all READMEs #34

Closed
6 of 9 tasks
jpmckinney opened this issue Oct 4, 2017 · 5 comments
Closed
6 of 9 tasks

META: Have examples in all READMEs #34

jpmckinney opened this issue Oct 4, 2017 · 5 comments
Labels
Community Relates to a regular extension Core Relates to a recommended extension Documentation Involves editing the readme or metadata
Milestone

Comments

@jpmckinney
Copy link
Member

jpmckinney commented Oct 4, 2017

And then include them in docs with jsoninclude directive.

We should ideally test that the example validates (see open-contracting/standard-maintenance-scripts#24)

@jpmckinney jpmckinney changed the title META: Create example.json files instead of putting examples in READMEs META: Create example.json files instead of putting examples in READMEs Oct 5, 2017
@jpmckinney jpmckinney self-assigned this Oct 5, 2017
@jpmckinney jpmckinney added the Documentation Involves editing the readme or metadata label Jan 1, 2018
@jpmckinney jpmckinney added Community Relates to a regular extension Core Relates to a recommended extension labels Jan 23, 2018
@jpmckinney jpmckinney removed their assignment Jun 25, 2018
@jpmckinney jpmckinney added this to the 1.1.4 milestone Nov 29, 2018
@jpmckinney
Copy link
Member Author

jpmckinney commented Dec 5, 2018

With the Extension Explorer, we don't want to use any Sphinx directives. However, having a separate example might be useful. We can see if (1, preferred) we can extract the example easily from a well-formatted readme (e.g. under an Example heading), or (2) if we ought to have a separate example file.

@jpmckinney jpmckinney changed the title META: Create example.json files instead of putting examples in READMEs META: Have examples in all READMEs Dec 5, 2018
@jpmckinney
Copy link
Member Author

jpmckinney commented Jan 22, 2019

We'll go with option (1) as we don't have an obvious solution for merging the example into the readme without adding an extra step for extension authors – and maintaining the same example in two places is otherwise a headache and creates room for misalignment.

@jpmckinney
Copy link
Member Author

jpmckinney commented Jan 29, 2019

@duncandewhurst Do you remember any potential existing examples for the other 8 extensions without examples listed in the issue description?

The finance example looks a bit long, but I'd be happy to merge some shortened version.

@jpmckinney jpmckinney added this to the 1.1.5 milestone Jan 29, 2019
@duncandewhurst
Copy link

We should be able to extract examples from the PPP sample data for charges, documentation_details, finance, qualification, risk_allocation, shareholders and (I think) process_title.

jpmckinney added a commit to open-contracting-extensions/ocds_charges_extension that referenced this issue Jan 30, 2019
jpmckinney added a commit to open-contracting-extensions/ocds_process_title_extension that referenced this issue Jan 30, 2019
jpmckinney added a commit to open-contracting-extensions/ocds_riskAllocation_extension that referenced this issue Jan 30, 2019
jpmckinney added a commit to open-contracting-extensions/ocds_shareholders_extension that referenced this issue Jan 30, 2019
jpmckinney added a commit to open-contracting-extensions/ocds_qualification_extension that referenced this issue Jan 30, 2019
jpmckinney added a commit to open-contracting-extensions/ocds_finance_extension that referenced this issue Jan 30, 2019
@jpmckinney
Copy link
Member Author

I added examples for 6 extensions, created blocking issues for 2 extensions, and will create a follow-up issue for milestone documents, which had no readily available example.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Community Relates to a regular extension Core Relates to a recommended extension Documentation Involves editing the readme or metadata
Projects
None yet
Development

No branches or pull requests

2 participants