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

Conversation

tkohr
Copy link
Contributor

@tkohr tkohr commented May 9, 2023

PR clarifies documentation of recordIdPath property for harvesting via a simple URL harvester.

Copy link
Member

@fgravin fgravin left a comment

Choose a reason for hiding this comment

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

Thanks for clarification and thanks @fxprunayre for investigations and checks.

@@ -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.

@fxprunayre
Copy link
Member

Don't forget to also highlight 4.2.4 new "features" of the ODS harvester geonetwork/core-geonetwork#7059

  • produce invalid ISO records
  • mix ISO topic categories with free text ODS themes whatever the languages and without icons

@fgravin
Copy link
Member

fgravin commented May 25, 2023

Don't forget to also highlight 4.2.4 new "features" of the ODS harvester geonetwork/core-geonetwork#7059

https://github.com/geonetwork/core-geonetwork/blob/main/CODE_OF_CONDUCT.md#our-standards

Trolling, insulting/derogatory comments, and personal or political attacks

@jodygarnett
Copy link
Contributor

This PR was still open? It missed out on the mkdocs conversion ... can you make this change to core-geonetwork please

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants