-
Notifications
You must be signed in to change notification settings - Fork 0
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
Comments
example.json
files instead of putting examples in READMEs
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. |
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. |
@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. |
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. |
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. |
And then include them in docs withjsoninclude
directive.contract_suppliersUpdate guidance on contract suppliers and change contract signatories to additional signatories #86documentation_details (PPP)Documentation: Remove content that ought to be in standard #84We should ideally test that the example validates (see open-contracting/standard-maintenance-scripts#24)
The text was updated successfully, but these errors were encountered: