Skip to content

Commit

Permalink
Add some documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
medihack committed Feb 13, 2024
1 parent 2aa9d9b commit 454447c
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
1 change: 0 additions & 1 deletion KNOWLEDGE.md

This file was deleted.

19 changes: 19 additions & 0 deletions doc/Maintenance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Maintenance

## How to upgrade

There are different things that can be upgraded:

- The python package dependencies (normal dependencies and dev dependencies)
-- Check outdated Python packages: `inv show-outdated` (check Python section in output)
-- `poetry update` will update packages according to their version range in `pyproject.toml`
-- Other upgrades (e.g. major versions) must be upgraded by modifying the version range in `pyproject.toml` before calling `poetry update`
- Javascript dependencies
-- Check outdated Javascript packages: `inv show-outdated` (check Javascript section in output)
-- `npm update` will update packages according to their version range in `package.json`
-- Other upgrades (e.g. major versions) must be upgraded by modifying the version range in `packages.json` before calling `npm update`
-- After an upgrade make sure the files in `static/vendor` still link to the correct files in `node_modules`1
- Python and Poetry in `Dockerfile` that builds the container where RADIS runs in
- Dependent services in `docker-compose.base.yml`, like PostgreSQL or Vespa database
- Gitpod development container dependencies in `.gitpod.Dockerfile`
- Github Codespaces development container dependencies in `.devcontainer/devcontainer.json` and `.devcontainer/Dockerfile`

0 comments on commit 454447c

Please sign in to comment.