From 76058b363dd1c28aca3ac24b51549b3c60b3c3ad Mon Sep 17 00:00:00 2001 From: Daniel Schadt Date: Mon, 5 Dec 2022 23:33:22 +0100 Subject: small documentation fixes --- CHANGELOG.rst | 5 +++++ README.md | 6 ++++-- doc/administration/upgrading.rst | 9 +++++++++ 3 files changed, 18 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 998dbab..faa65e3 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -4,6 +4,11 @@ Changelog Unreleased ---------- +Fixed +^^^^^ + +- Account registration giving a 400 error. + 0.4.0 - 2022-11-28 ------------------ diff --git a/README.md b/README.md index d6a1ba9..c2f52d8 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,8 @@ Installation Setup instructions are in the documentation. You can either build it locally using [Sphinx](https://www.sphinx-doc.org/), or view the generated version -online: https://kingdread.de/fietsboek/ +online: https://docs.fietsboek.org/ +([mirror](https://fietsboek.readthedocs.io/)). Development ----------- @@ -28,7 +29,8 @@ Development - Adjust `development.ini` to your needs - Initialize the database: - .venv/bin/alembic -c development.ini updgrade head + .venv/bin/alembic -c development.ini upgrade head + - Serve the code: .venv/bin/pserve development.ini --reload diff --git a/doc/administration/upgrading.rst b/doc/administration/upgrading.rst index 9d19f90..2b69e4c 100644 --- a/doc/administration/upgrading.rst +++ b/doc/administration/upgrading.rst @@ -27,6 +27,15 @@ done in the following way: If you have downloaded an archive with the Fietsboek source, you need to download the archive with the new version and extract it somewhere. +.. tip:: + + If upgrading fails, try going in smaller steps, e.g. release by release. If + you upgrade over a big version span, the chances are bigger that unintended + interactions occur. + + To do that, use ``git`` or ``pip`` to download specific versions of the + code instead of going for the latest one. + Installing the Python Module ---------------------------- -- cgit v1.2.3