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

Add the missing assets build step to the page on how to develop custo… #588

Merged
merged 3 commits into from
Oct 17, 2023
Merged
Show file tree
Hide file tree
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: 6 additions & 0 deletions docs/develop/howtos/custom_fields.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,12 @@ export class Experiments extends Component {
}
```

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
```

!!! 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.
Expand Down
8 changes: 4 additions & 4 deletions docs/releases/upgrading/upgrade-v7.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand All @@ -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.


Expand Down Expand Up @@ -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
Expand All @@ -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.
2 changes: 1 addition & 1 deletion docs/releases/upgrading/upgrade-v8.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -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! 🥳
2 changes: 1 addition & 1 deletion docs/releases/upgrading/upgrade-v9.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -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! 🥳
3 changes: 0 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Loading