custom fields: link to custom fields docs and re-word description #916
custom fields: link to custom fields docs and re-word description #916tmorrell wants to merge 1 commit intoinveniosoftware:masterfrom
Conversation
…optional custom fields Updated section header and improved wording for clarity.
| In addition to supporting your own custom extensions, InvenioRDM provides a set of ready-to-use add-on fields—implemented via custom fields—that can be enabled without advanced configuration. | ||
| ## Optional custom fields | ||
| [Custom fields](../operate/customize/metadata/custom_fields/records/#declaring-custom-fields) are the recommended way to extend the internal data model to fit your specific needs. | ||
| In addition to supporting your own custom extensions, InvenioRDM provides a set of ready-to-use add-on optional custom fields that can be enabled without advanced configuration. |
There was a problem hiding this comment.
Agreed that this section's header is incorrect and bundles up two related concepts without a thoughtful progressive explanation of them.
I'd go for either:
a) one section that covers Optional fields and custom fields in that order
## Custom fields to ## Optional fields and custom fields
With body:
InvenioRDM provides a set of ready-to-use add-on optional (custom) fields that can be enabled without advanced configuration. Those fields are grouped under: Journal, Imprint, Thesis, Meeting, and Codemeta bundles. See the [related documentation](../operate/customize/metadata/optional_fields.md) on how to enable them.
If those groups don't cover the fields you need, it's possible to extend the internal data model to fit your specific needs by creating your own custom fields in your instance. See the [related documentation](../operate/customize/metadata/custom_fields/records.md) on how to do so.... rest of group references (Journal, ...)
OR
b) split that into 2 sections
## Optional fields
first paragraph of a)
... rest of group references (Journal, ...)
## Custom fields
second paragraph of a)
We want to guide the reader down to using custom fields by passing through simpler/likely solutions first so they don't go to the deep end before they need to.
I think I provided the correct link in text above also, so can be used to fix the failing CI.
Description
The heading talks about custom fields, but these aren't really custom fields since they are system defined. I added in a link to the actual custom field documentation, and adjusted the wording to be a bit clearer. The specific wording could be debated.
Checklist
Ticks in all boxes and 🟢 on all GitHub actions status checks are required to merge:
masterbranch.productionbranch following approval or indicate to a maintainer that it should be backported.Reminder
By using GitHub, you have already agreed to the GitHub’s Terms of Service including that: