Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-16 21:06:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Clean up evennia-update doc page

Browse source
This commit is contained in:
Griatch 2023-08-07 09:17:29 +02:00
parent 46809de539
commit bc77c691ae
1 changed files with 3 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

9
docs/source/Setup/Updating-Evennia.md
View file

@ -12,12 +12,9 @@ If you followed the [normal install instructions](./Installation.md), here's wha
4. `evennia stop`
5. `pip install --upgrade evennia`
6. `cd` tor your game dir
7. `evennia migrate` (_ignore_ any warnings about running `makemigrations`, it should _not_ be done)
7. `evennia migrate` - this is safe to do, but can be skipped unless the release announcement/changelog specifically tells you to do so. _Ignore_ any warnings about running `makemigrations`, it should _not_ be done!
8. `evennia start`
If the upstream changes are large, you may also need to go into your gamedoor
## If you installed with `git`
This applies if you followed the [git-install instructions](./Installation-Git.md). Before Evennia 1.0, this was the only way to install Evennia.
@ -32,7 +29,7 @@ At any time, development is either happening in the `main` branch (latest stable
6. `git pull`
7. `pip install --upgrade -e .` (remember the `.` at the end!)
9. `cd` back to your game dir
10. `evennia migrate` (_ignore_ any warnings about running `makemigrations` , it should _not_ be done)
10. `evennia migrate` - this is safe to do, but can be skipped unless the release announcement/changelog specifically tells you to do so. _Ignore_ any warnings about running `makemigrations`, it should _not_ be done!
11. `evennia start`
## If you installed with `docker`
@ -91,4 +88,4 @@ If and when an Evennia update modifies the database *schema* (that is, the under
One way one could handle this is to apply the changes manually to your database using the database's command line. This often means adding/removing new tables or fields as well as possibly convert existing data to match what the new Evennia version expects. It should be quite obvious that this quickly becomes cumbersome and error-prone. If your database doesn't contain anything critical yet it's probably easiest to simply reset it and start over rather than to bother converting.
Enter *migrations*. Migrations keeps track of changes in the database schema and applies them automatically for you. Basically, whenever the schema changes we distribute small files called "migrations" with the source. Those tell the system exactly how to implement the change so you don't have to do so manually. When a migration has been added we will tell you so on Evennia's mailing lists and in commit messages - you then just run `evennia migrate` to be up-to-date again.
Enter *migrations*. Migrations keeps track of changes in the database schema and applies them automatically for you. Basically, whenever the schema changes we distribute small files called "migrations" with the source. Those tell the system exactly how to implement the change so you don't have to do so manually. When a migration has been added we will tell you so on Evennia's mailing lists and in commit messages - you then just run `evennia migrate` to be up-to-date again.