Skip to content

Commit

Permalink
Merge pull request #4363 from GeotrekCE/doc_update_release_and_mainte…
Browse files Browse the repository at this point in the history
…nance

📝 [DOC] Update release and maintenance doc
  • Loading branch information
Chatewgne authored Nov 15, 2024
2 parents b89ae96 + 5ffe2cf commit e6096d7
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 8 deletions.
4 changes: 4 additions & 0 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ CHANGELOG

- Fix missing Dockerfile path on make build scripts

**Documentation**

- Update documentation for release and update obsolete example


2.110.0 (2024-11-13)
----------------------------
Expand Down
10 changes: 5 additions & 5 deletions docs/contribute/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,16 +103,16 @@ Release

On master branch:

* Update files *VERSION*, *docs/conf.py* and *docs/changelog.rst* to remove ``+dev`` suffix and increment version (please use semver rules)
* Update files *VERSION* and *docs/changelog.rst* to remove ``+dev`` suffix and increment version (please use semver rules)
* Run ``dch -r -D RELEASED``, update version in the same way and save
* Commit with message 'Release x.y.z' and push to ``master``
* Create new release on Github, with tag X.Y.Z, click on "Generate release notes"
* Commit with message 'Release X.Y.Z' and push to ``master``
* Create new release with name 'Geotrek-admin X.Y.Z' on Github, with tag X.Y.Z, click on "Generate release notes"
* Wait for release to be published through CI
* Update files *VERSION*, *docs/conf.py* and *docs/changelog.rst* to add ``+dev`` suffix
* Update files *VERSION* and *docs/changelog.rst* to add ``+dev`` suffix
* Run ``dch -v <version>+dev --no-force-save-on-release`` and save
* Commit with message 'Back to development' and push to ```master``

* When creating a new release 'x.y.z' on github, Github actions will generate the .deb package file, and publish it on https://packages.geotrek.fr (see ``.github/workflows/test.yml`` file for details)
* When creating a new release 'X.Y.Z' on github, Github actions will generate the .deb package file, and publish it on https://packages.geotrek.fr (see ``.github/workflows/test.yml`` file for details)

Other ways to contribute
-------------------------
Expand Down
4 changes: 1 addition & 3 deletions docs/install/maintenance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,9 @@ Application restore
If you restore Geotrek-admin on a new server, you will have to install PostgreSQL and PostGIS and create a database user first.
Otherwise go directly to the database creation step.

Example for Ubuntu 18:

.. code-block:: bash
sudo apt install postgresql-10 postgresql-10-postgis-2.5
sudo apt install postgresql-14 postgresql-14-postgis-3
sudo -u postgres psql -c "CREATE USER geotrek PASSWORD 'geotrek';"
Expand Down

0 comments on commit e6096d7

Please sign in to comment.