From 772f51d618660043742f5a0e5b50d748405b3b2d Mon Sep 17 00:00:00 2001 From: Felix Rindt Date: Wed, 2 Aug 2023 19:44:21 +0200 Subject: [PATCH] add external packages to dev setup guide --- docs/admin/deployment/index.rst | 10 ++++++++++ docs/admin/index.rst | 2 +- docs/admin/installation/index.rst | 7 ------- docs/development/contributing.rst | 14 +++++++++++++- 4 files changed, 24 insertions(+), 9 deletions(-) create mode 100644 docs/admin/deployment/index.rst delete mode 100644 docs/admin/installation/index.rst diff --git a/docs/admin/deployment/index.rst b/docs/admin/deployment/index.rst new file mode 100644 index 000000000..f7b04ae4e --- /dev/null +++ b/docs/admin/deployment/index.rst @@ -0,0 +1,10 @@ +Deploying ephios +================ + +This section shows how to deploy ephios in a production environment. + +.. note:: This page is work in progress. Feel free to contribute. Either way, ephios can be deployed like most django apps. + + +.. toctree:: + :maxdepth: 2 diff --git a/docs/admin/index.rst b/docs/admin/index.rst index ab1b9228f..cb587c455 100644 --- a/docs/admin/index.rst +++ b/docs/admin/index.rst @@ -6,5 +6,5 @@ This section shows how to install and configure ephios. .. toctree:: :maxdepth: 2 - installation/index + deployment/index additional_features/index diff --git a/docs/admin/installation/index.rst b/docs/admin/installation/index.rst deleted file mode 100644 index b72a78bf9..000000000 --- a/docs/admin/installation/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -Installing ephios -================= - -This section shows how to install ephios. - -.. toctree:: - :maxdepth: 2 diff --git a/docs/development/contributing.rst b/docs/development/contributing.rst index c98d8b115..59e7210a0 100644 --- a/docs/development/contributing.rst +++ b/docs/development/contributing.rst @@ -17,8 +17,14 @@ Development setup To set up a development version on your local machine, you need to execute the following steps: +#. Install external packages required for developing ephios + + * ``git`` (to check out the repository) + * ``python`` version 3.8 or higher including dev and virtualenv tooling + * ``gettext`` (to compile translations, might also be named ``msgfmt``) + #. Check out the `repository `_ and cd to it -#. Set up a virtualenv for the project with Python >=3.8 and activate it +#. Set up a virtualenv for the project activate it #. Install poetry (if not already installed): `Installation guide `_ #. Install dependencies with ``poetry install`` #. Create env file with ``cp .env.example .env`` @@ -28,6 +34,12 @@ To set up a development version on your local machine, you need to execute the f #. Start the development server with ``python manage.py runserver`` #. Open your web browser, visit ``http://localhost:8000`` and log in with the default credentials (user ``admin@localhost`` and password ``admin``) +If those steps did not work for you, please contact us or open an issue in the GitHub repository. + +.. warning:: + The default development server is not suitable for production use. It is not secure and not performant. + If you want to run ephios in production, please follow the :doc:`deployment guide ` + Tests -----