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

Harvesting: Clarify recordIdPath change in GN > 4.2.2 #240

Open
wants to merge 1 commit into
base: 4.0.x
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions source/user-guide/harvesting/harvesting-simpleurl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ Adding a simple URL harvester
Note: GN looks for schemas by name in https://github.com/geonetwork/core-geonetwork/tree/4.0.x/web/src/main/webapp/xsl/conversion/import. These schemas might internally include schemas from other locations like https://github.com/geonetwork/core-geonetwork/tree/4.0.x/schemas/iso19115-3.2018/src/main/plugin/iso19115-3.2018/convert. To indicate the ``fromJsonOpenDataSoft`` schema for example, from the latter location directly in the admin UI the following syntax can be used: ``schema:iso19115-3.2018:convert/fromJsonOpenDataSoft``.


**Sample configuration for opendatasoft**
**Sample configuration for opendatasoft v1**

- *loopElement* - ``/datasets``
- *numberOfRecordPath* : ``/nhits``
- *recordIdPath* : ``datasetid``
- *recordIdPath* : ``datasetid`` (*ODS v2* : ``dataset/dataset_id``)
- *pageFromParam* : ``start``
- *pageSizeParam* : ``rows``
- *toISOConversion* : ``OPENDATASOFT-to-ISO19115-3-2018``
Expand All @@ -50,5 +50,7 @@ Adding a simple URL harvester
- *pageSizeParam* : ``rows``
- *toISOConversion* : ``DKAN-to-ISO19115-3-2018``

Note: In GN versions > 4.2.2 the ``recordIdPath`` property needs to start with a ``/``. Schemas bearing similar names can be selected via a dropdown here.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a documenter expert, but if we start adding additional notes for each change in each release, readability of the doc in a couple of years will be a challenge, end users will have to read the top text and then applies all the notes with changes in each versions to have the full picture... Readability would be facilitated if the main text represent the current status and additional note highlight changes in past version so end user will have to read the note only if using old stuff? Also consider https://geonetwork-opensource.org/manuals/4.0.x/en/contributing/writing-documentation.html#versionadded-versionchanged-and-deprecated

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree.
Breaking changes should be documented somewhere though.


- **Privileges** - Assign privileges to harvested metadata.