Skip to content

Commit

Permalink
Feedback from @fenekku
Browse files Browse the repository at this point in the history
  • Loading branch information
tmorrell committed Jul 10, 2024
1 parent 8b66717 commit 98a0ec8
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions docs/develop/getting-started/instance-development.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ First, checkout the [package development guide](package-development.md) to learn
how to develop on a single Python package. To integrate your Python package into
a development install of an InvenioRDM instance see below:

**Install a module in an instance**
#### Install a module in an instance

Once you have a source code checkout, you can install the module in the
development instance:
Expand All @@ -69,25 +69,28 @@ invenio-cli run
invenio-cli services destroy
invenio-cli services setup

#### Install a forked package in an instance

In some cases you might want to include a forked package in your InvenioRDM
instance permanently. For example, you might have a local identifier scheme that
you want [idutils](https://github.com/inveniosoftware/idutils)
to verify. It wouldn't be appropriate to make a pull request, since this
change is only relevant to your organization. You can make your fork available on GitHub
and add the following to your Pipfile
and add the following to your Pipfile:

```
[packages]
idutils = {git = "https://github.com/your-username/idutils.git", ref = "main"}
```

You may need to delete your Pipfile.lock and run `invenio-cli install` the first time you make this change.
You will need to update your `Pipfile.lock` after this kind of change. Run
`pipenv lock` or `invenio-cli install`.

!!! warning
It's not recommended to do this with invenio packages that change often,
since it will be difficult to keep your fork up to date.

**Edit CSS and JavaScript included in Python modules**
#### Edit CSS and JavaScript included in Python modules

Some Python modules includes CSS/JavaScript which is usually located in
``assets/`` folders in the project.
Expand Down

0 comments on commit 98a0ec8

Please sign in to comment.