AtlasOfLivingAustralia / la-pipelines

Living Atlas Pipelines extensions
3 stars 4 forks source link

Automatically update technical section on assertion wiki pages #435

Closed RobinaSanderson closed 3 years ago

RobinaSanderson commented 3 years ago

Create and run a script that edits the assertion wiki pages as follows:

1. Code Reference The template for documenting assertions developed during the data quality project includes a section with a Code reference or Technical information link.

As an example: https://github.com/AtlasOfLivingAustralia/ala-dataquality/wiki/COORDINATES_CENTRE_OF_COUNTRY

For new assertions this needs to be populated.

For existing assertions (such as the example above) new links are required for pipelines.

Question: do we keep the old links to biocache to assist Living Atlases? If so, we should have headings for Post-Pipelines Upgrade and Pre-Pipelines Upgrade Already addressed.

As code is changing continuously a link to a fixed line of code will be outdated quickly a link to a representative search in pipelines or related repo will be used, instead of a fixed code line, so someone reading the wiki pages can find their way from it.

A couple of examples of the suggested search

Pipelines repo search https://github.com/search?q=repo%3Agbif%2Fpipelines+MISSING_COLLECTION_DATE+in%3Afile&type=Code

GBIF organisation search https://github.com/search?q=org%3Agbif+MISSING_COLLECTION_DATE+in%3Afile&type=Code

2. Replaces For assertions that replace an old one, populate this section as follows:

3. Required fields

javier-molina commented 3 years ago

Can the addition of links to source code be automated by running a script across a set of wiki files?

brucehyslop commented 3 years ago

Updates have been applies to the assertions wiki pages and can be managed / synced using the script. See #512

javier-molina commented 3 years ago

@RobinaSanderson I have glanced through a few pages and things look good.

Do you have any comments on the result before we close this ticket?

javier-molina commented 3 years ago

Reviewed by Robina and myself, looks good.