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: Improve all extensions' documentation #143

Open
2 tasks
jpmckinney opened this issue Jul 23, 2020 · 3 comments
Open
2 tasks

META: Improve all extensions' documentation #143

jpmckinney opened this issue Jul 23, 2020 · 3 comments
Labels
Community Relates to a regular extension Core Relates to a recommended extension Documentation Involves editing the readme or metadata

Comments

@jpmckinney
Copy link
Member

jpmckinney commented Jul 23, 2020

The newest extensions (from work on the OCDS for EU profile) follow a consistent format. There can sometimes be more expansion of their use cases, but in general they are fairly straightforward.

The quality and format of some earlier extensions' documentation is inconsistent.

This issue is about:

  • Identify the best examples of extension documentation
  • Create a backlog of extensions that need improvement
  • Work through them one at a time

Then, Duncan can review for correctness (hopefully quick), and James can do a final review for style and consistency.

@jpmckinney jpmckinney added Documentation Involves editing the readme or metadata Core Relates to a recommended extension Community Relates to a regular extension labels Jul 23, 2020
@ColinMaudry
Copy link
Member

I may have missed something, but I think the latest extensions miss a link to their page in the extension explorer (ex https://extensions.open-contracting.org/en/extensions/awardCriteria/master/). That would be a useful addition to extension's READMEs.

@ColinMaudry
Copy link
Member

Ah, we have used the Github "website" field to document the page in the extension explorer. That's good, but I'm not sure people will find it (I had forgotten about it).

@jpmckinney
Copy link
Member Author

I can check the analytics, but I don't think many people visit the extensions on GitHub – we expect people to always use the Extension Explorer.

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