From 4ec7afb0046db0474310c2c28e7e6923570c963d Mon Sep 17 00:00:00 2001 From: Ginger Burns Date: Mon, 4 Nov 2024 10:30:45 +0000 Subject: [PATCH 1/3] docs: fix tests badge --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d7ff7b9..33c71e2 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ # ckanext-attribution -[![Tests](https://img.shields.io/github/actions/workflow/status/NaturalHistoryMuseum/ckanext-attribution/main.yml?style=flat-square)](https://github.com/NaturalHistoryMuseum/ckanext-attribution/actions/workflows/main.yml) +[![Tests](https://img.shields.io/github/actions/workflow/status/NaturalHistoryMuseum/ckanext-attribution/tests.yml?style=flat-square)](https://github.com/NaturalHistoryMuseum/ckanext-attribution/actions/workflows/tests.yml) [![Coveralls](https://img.shields.io/coveralls/github/NaturalHistoryMuseum/ckanext-attribution/main?style=flat-square)](https://coveralls.io/github/NaturalHistoryMuseum/ckanext-attribution) [![CKAN](https://img.shields.io/badge/ckan-2.9.7-orange.svg?style=flat-square)](https://github.com/ckan/ckan) [![Python](https://img.shields.io/badge/python-3.6%20%7C%203.7%20%7C%203.8-blue.svg?style=flat-square)](https://www.python.org/) From 062a0244a607233b00178f8dac45cb0877163a9e Mon Sep 17 00:00:00 2001 From: Ginger Burns Date: Mon, 4 Nov 2024 10:36:06 +0000 Subject: [PATCH 2/3] docs: fix agent table --- README.md | 24 +++++++++++------------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 33c71e2..b17f0f9 100644 --- a/README.md +++ b/README.md @@ -37,19 +37,17 @@ between these and `Package` records). Defines _one_ agent. -| Field | Type | Values | Notes | -|---------------------|--------|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `agent_type` | string | 'person', 'org', 'other' | | -| `family_name` | string | | only used for 'person' records | -| `given_names` | string | | only used for 'person' records | -| `given_names_first` | bool | True, False | only used for 'person' records; if the given names should be displayed first according to the person's culture/language (default True) | -| `name` | string | | used for non-'person' records | -| `location` | string | | used for non-person records, optional; a location to display for the organisation to help differentiate between similar names (e.g. 'Natural History Museum (_ | - -London_)' and 'Natural History Museum (_Dublin_)') -`external_id`|string||an identifier from an external service like ORCID or ROR -`external_id_scheme`|string|'orcid', 'ror', other|the scheme for the `external_id`; currently only 'orcid' and 'ror' are fully supported, though basic support for others can be implemented by adding to the `attribution_controlled_lists` [action](ckanext/attribution/logic/actions/extra.py#L14) -`user_id`|string|`User.id` foreign key|link to a user account on the CKAN instance +| Field | Type | Values | Notes | +|----------------------|--------|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `agent_type` | string | 'person', 'org', 'other' | | +| `family_name` | string | | only used for 'person' records | +| `given_names` | string | | only used for 'person' records | +| `given_names_first` | bool | True, False | only used for 'person' records; if the given names should be displayed first according to the person's culture/language (default True) | +| `name` | string | | used for non-'person' records | +| `location` | string | | used for non-person records, optional; a location to display for the organisation to help differentiate between similar names (e.g. 'Natural History Museum (_London_)' and 'Natural History Museum (_Dublin_)') + `external_id` | string | | an identifier from an external service like ORCID or ROR + `external_id_scheme` | string | 'orcid', 'ror', other | the scheme for the `external_id`; currently only 'orcid' and 'ror' are fully supported, though basic support for others can be implemented by adding to the `attribution_controlled_lists` [action](ckanext/attribution/logic/actions/extra.py#L14) + `user_id` | string | `User.id` foreign key | link to a user account on the CKAN instance ### `ContributionActivity` From 762b4013522abc565f16977fa2ba764b9aedd781 Mon Sep 17 00:00:00 2001 From: Ginger Burns Date: Mon, 4 Nov 2024 11:10:58 +0000 Subject: [PATCH 3/3] docs: use variable logo based on colour scheme --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b17f0f9..ab400c7 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ - + + + + The Natural History Museum logo. + # ckanext-attribution