Skip to content

custom fields: link to custom fields docs and re-word description #916

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.

Sign up for GitHub

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

Open
tmorrell wants to merge 1 commit into
base: master
Choose a base branch
from
Open

custom fields: link to custom fields docs and re-word description #916

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 3 additions & 3 deletions docs/reference/metadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1014,9 +1014,9 @@
}
```

## Custom fields
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 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.

Check failure on line 1019 in docs/reference/metadata.md

View workflow job for this annotation

GitHub Actions / Tests 

bad links:
  reference/operate/customize/metadata/custom_fields/records
Copy link
Copy Markdown
Collaborator

@fenekku fenekku Mar 5, 2026

Choose a reason for hiding this comment

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

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.


See the [related documentation](../operate/customize/metadata/optional_fields.md) on how to enable them.

Expand Down
Loading