From bf41556c92698de94b72e72986c01a5bbb4e9e05 Mon Sep 17 00:00:00 2001 From: Maxime Turcotte Date: Tue, 17 Oct 2023 10:20:26 -0400 Subject: [PATCH 1/3] Add the missing assets build step to the page on how to develop custom fields --- docs/develop/howtos/custom_fields.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/develop/howtos/custom_fields.md b/docs/develop/howtos/custom_fields.md index be5d3426..73afa432 100644 --- a/docs/develop/howtos/custom_fields.md +++ b/docs/develop/howtos/custom_fields.md @@ -143,6 +143,12 @@ export class Experiments extends Component { } ``` +Since we added a new asset, we need to rebuild them: + +```bash +$ invenio-cli assets build +``` + !!! tip "Where to place a custom UI widget?" Custom UI widgets can be implemented in multiple places. Besides in the instance, they can also be implemented in other modules such as `react-invenio-deposit` or `react-invenio-forms`, however be aware that "where" to place a widget depends on "who" needs the custom field. From 81ba9748e9dd5829c825f836571213e6cc53a082 Mon Sep 17 00:00:00 2001 From: Maxime Turcotte Date: Tue, 17 Oct 2023 13:33:23 -0400 Subject: [PATCH 2/3] Update docs/develop/howtos/custom_fields.md Co-authored-by: Guillaume Viger --- docs/develop/howtos/custom_fields.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/develop/howtos/custom_fields.md b/docs/develop/howtos/custom_fields.md index 73afa432..a803c719 100644 --- a/docs/develop/howtos/custom_fields.md +++ b/docs/develop/howtos/custom_fields.md @@ -143,7 +143,7 @@ export class Experiments extends Component { } ``` -Since we added a new asset, we need to rebuild them: +Since we added a new Javascript file, we need to [rebuild our assets](../../customize/look-and-feel/theme.md#automatic-re-build): ```bash $ invenio-cli assets build From 5d3df9f72e3cc37b35ca014bab7975174a0dd96f Mon Sep 17 00:00:00 2001 From: Guillaume Viger Date: Tue, 17 Oct 2023 16:40:09 -0400 Subject: [PATCH 3/3] build: fix emoji package warning --- docs/releases/upgrading/upgrade-v7.0.md | 8 ++++---- docs/releases/upgrading/upgrade-v8.0.md | 2 +- docs/releases/upgrading/upgrade-v9.0.md | 2 +- mkdocs.yml | 3 --- 4 files changed, 6 insertions(+), 9 deletions(-) diff --git a/docs/releases/upgrading/upgrade-v7.0.md b/docs/releases/upgrading/upgrade-v7.0.md index 7cb96828..66cf1df0 100644 --- a/docs/releases/upgrading/upgrade-v7.0.md +++ b/docs/releases/upgrading/upgrade-v7.0.md @@ -35,7 +35,7 @@ If the command gives a different output, the database was likely on an older sta ### Updating Configuration Variables -**Note**: The DataCite-related configuration values have been renamed in v7! +**Note**: The DataCite-related configuration values have been renamed in v7! Please adjust your configurations in `invenio.cfg` as per the following table: | Old Name | New Name | @@ -49,7 +49,7 @@ Please adjust your configurations in `invenio.cfg` as per the following table: Further, the `OAISERVER_ID_PREFIX` needs to be set to the site name (without the protocol, e.g. `inveniordm.web.cern.ch`), -even if you don't intend to use the OAI-PMH feature. +even if you don't intend to use the OAI-PMH feature. During the migration, the OAI PIDs will be created for each record and this variable ensures that they have meaningful values. @@ -101,7 +101,7 @@ The mentioned records must be fixed manually (usually a matter of manipulating t #### Success -If no errors were reported, congratulations on the successful data migration! :partying_face: +If no errors were reported, congratulations on the successful data migration! 🥳 ### Elasticsearch @@ -123,4 +123,4 @@ As soon as the indices have been rebuilt, the entire migration is complete! *December 7th, 2021*: Added required last step (Elasticsearch) because we *did* find some changes in the mappings, and updated some wording and headings. -*March 3rd, 2022*: Removed the `invenio alembic stamp` command from the upgrade guide, because the command does not actually find out the current revisions for the database. +*March 3rd, 2022*: Removed the `invenio alembic stamp` command from the upgrade guide, because the command does not actually find out the current revisions for the database. diff --git a/docs/releases/upgrading/upgrade-v8.0.md b/docs/releases/upgrading/upgrade-v8.0.md index d9fb5ba9..b88427db 100644 --- a/docs/releases/upgrading/upgrade-v8.0.md +++ b/docs/releases/upgrading/upgrade-v8.0.md @@ -56,4 +56,4 @@ pipenv run invenio rdm-records rebuild-index This will ensure that all indices and their contents are based on the latest definitions and not out of date. -As soon as the indices have been rebuilt, the entire migration is complete! :partying_face: +As soon as the indices have been rebuilt, the entire migration is complete! 🥳 diff --git a/docs/releases/upgrading/upgrade-v9.0.md b/docs/releases/upgrading/upgrade-v9.0.md index b677527c..9aba5748 100644 --- a/docs/releases/upgrading/upgrade-v9.0.md +++ b/docs/releases/upgrading/upgrade-v9.0.md @@ -133,4 +133,4 @@ pipenv run invenio rdm-records rebuild-index This will ensure that all indices and their contents are based on the latest definitions and not out of date. -As soon as the indices have been rebuilt, the entire migration is complete! :partying_face: +As soon as the indices have been rebuilt, the entire migration is complete! 🥳 diff --git a/mkdocs.yml b/mkdocs.yml index 3fa4adff..c64da029 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -232,6 +232,3 @@ markdown_extensions: - toc: permalink: true - - pymdownx.emoji: - emoji_index: !!python/name:materialx.emoji.twemoji - emoji_generator: !!python/name:materialx.emoji.to_svg