Language corrections

This commit is contained in:
LenaertsJ 2024-05-07 14:51:31 +00:00
parent 5334779b55
commit d63e1a15bd

View File

@ -20,7 +20,7 @@ You will learn here how to install a new symfony project with chill, and configu
Requirements
============
The installation is tested on Debian-like linux distribution. The installation on other operating systems is not documented.
The installation is tested on a Debian-like linux distribution. The installation on other operating systems is not documented.
You have to install the following tools on your computer:
@ -32,9 +32,9 @@ You have to install the following tools on your computer:
- `yarn <https://classic.yarnpkg.com/lang/en/docs/install/>`_. We use the version 1.22+ for now.
- `docker and the plugin compose <https://docker.com>`_ to run the database
Chill needs a redis server and a postgresql database, and some stuffes like a "relatorio service" which will
generate documents from templates. **All those stuffes are available trough docker with the plugin compose**. We do not provide
information of how to run it without it.
Chill needs a redis server and a postgresql database, and a few other things like a "relatorio service" which will
generate documents from templates. **All these things are available through docker using the plugin compose**. We do not provide
information on how to run this without docker compose.
Install a new project
@ -52,14 +52,14 @@ We strongly encourage you to initialize a git repository at this step, to track
.. code-block:: bash
# add the flex endpoints required to custom recipes
# add the flex endpoints required for custom recipes
cat <<< "$(jq '.extra.symfony += {"endpoint": ["flex://defaults", "https://gitlab.com/api/v4/projects/57371968/repository/files/index.json/raw?ref=main"]}' composer.json)" > composer.json
# install chill and some dependencies
# TODO fix the suffix "alpha1" and replace by ^3.0.0 when version 3.0.0 will be released
composer require chill-project/chill-bundles v3.0.0-alpha1 champs-libres/wopi-lib dev-master@dev champs-libres/wopi-bundle dev-master@dev
We encourage you to accept to include the "Docker configuration from recipes": this is the documented way to run database.
You must also accept to configure recipes from the contrib repository, unless you want to configure by yourself the bundles).
We encourage you to accept the inclusion of the "Docker configuration from recipes": this is the documented way to run the database.
You must also accept to configure recipes from the contrib repository, unless you want to configure the bundles manually).
.. code-block:: bash
@ -90,17 +90,17 @@ You must also accept to configure recipes from the contrib repository, unless yo
Configure your project
**********************
You should carefully read the configuration files in :code:`chill/config/packages`, especially if you have
You should read the configuration files in :code:`chill/config/packages` carefully, especially if you have
custom developments. But most of the time, this should be fine.
You have to configure some local variable, which are described in the :code:`.env` file. The secrets should not be stored
in this :code:`.env` file, but instead using the `secret management tool <https://symfony.com/doc/current/configuration/secrets.html>`_
or in the :code:`.env.local` file, which should not be commited to git repository.
You have to configure some local variables, which are described in the :code:`.env` file. The secrets should not be stored
in this :code:`.env` file, but instead using the `secrets management tool <https://symfony.com/doc/current/configuration/secrets.html>`_
or in the :code:`.env.local` file, which should not be commited to the git repository.
You do not need to set variables for the smtp server, redis server and relatorio server, as they are generated automatically
by the symfony server, from the docker compose services.
The only required variable in the :code:`ADMIN_PASSWORD`. You can generate an hashed and salted admin password using the command
The only required variable is the :code:`ADMIN_PASSWORD`. You can generate a hashed and salted admin password using the command
:code:`symfony console security:hash-password <your password> 'Symfony\Component\Security\Core\User\User'`. Then,
you can either:
@ -111,7 +111,7 @@ you can either:
ADMIN_PASSWORD=\$2y\$13\$iyvJLuT4YEa6iWXyQV4/N.hNHpNG8kXlYDkkt5MkYy4FXcSwYAwmm
- add the generated password to the secret management (**note**: you must add the generated hashed password to the secrets env,
- add the generated password to the secrets manager (**note**: you must add the generated hashed password to the secrets env,
not the password in clear text).
Prepare migrations and other tools
@ -133,7 +133,7 @@ To continue the installation process, you will have to run migrations:
.. warning::
If you encounter error while running :code:`symfony console messenger:setup-transports`, you can set up the messenger
If you encounter an error while running :code:`symfony console messenger:setup-transports`, you can set up the messenger
transport to redis, by adding this in the :code:`.env.local` or :code:`.env` file:
.. code-block:: env
@ -143,7 +143,7 @@ To continue the installation process, you will have to run migrations:
Start your web server locally
*****************************
At this step, Chill will be ready for serving locally, but does not contains any configuration. You can run the project
At this step, Chill will be ready to be served locally, but without any configuration. You can run the project
locally using the `local symfony server <https://symfony.com/doc/current/setup/symfony_server.html>`_:
.. code-block:: bash
@ -152,16 +152,16 @@ locally using the `local symfony server <https://symfony.com/doc/current/setup/s
symfony server:start -d
If you need to test the instance with accounts and some basic configuration, install fixtures (see below).
If you need to test the instance with accounts and some basic configuration, please install the fixtures (see below).
Add capabilities for dev
========================
If you need to add custom bundles, you can develop them in the `src/` directory, like any other symfony projects. You
can rely on the whole chill framework from there: there is no need to add them to the original `chill-bundles`.
If you need to add custom bundles, you can develop them in the `src/` directory, like for any other symfony project. You
can rely on the whole chill framework, meaning there is no need to add them to the original `chill-bundles`.
You will require some bundles to have development tools:
You will require some bundles to have the following development tools:
- add fixtures
- add profiler and var-dumper to debug
@ -197,11 +197,11 @@ Add web profiler and debugger
Working on chill bundles
************************
If you plan to improve the chill-bundles repository, this is great!
If you plan to improve the chill-bundles repository, that's great!
You must download chill-bundles as a git repository (and not as an archive, which is barely editable).
You will have to download chill-bundles as a git repository (and not as an archive, which is barely editable).
In your :code:`composer.json` file, add those lines:
In your :code:`composer.json` file, add these lines:
.. code-block:: diff
@ -226,13 +226,13 @@ We also encourage you to use tools like `phpstan <https://phpstan.org>`_ and `re
Commit and share your project
=============================
If multiple developers works on the project, you can commit your symfony project and share it with other people.
If multiple developers work on a project, you can commit your symfony project and share it with other people.
When another developers clone your project, they will have to:
When another developer clones your project, they will have to:
- run :code:`composer install` and :code:`yarn install` to install the same dependencies as the initial developer;
- run :code:`yarn run encore production` to compile assets;
- copy eventually variables from the :code:`.env.local` files;
- copy any possible variables from the :code:`.env.local` files;
- start the docker compose stack, using :code:`docker compose`, and run migrations, set up transports, and prepare chill db views
(see the corresponding command above)
@ -242,7 +242,7 @@ Update
In order to update your app, you must update dependencies:
- for chill-bundles, you can `set the last version <https://gitlab.com/Chill-Projet/chill-bundles/-/releases>`_ manually
in the :code:`composer.json` file, or set to the version to `^3.0.0` and run :code:`composer update` regularly
in the :code:`composer.json` file, or set the version to `^3.0.0` and run :code:`composer update` regularly
- run :code:`composer update` and :code:`yarn update` to maintain your dependencies up-to-date.
After each update, you must update your database schema:
@ -290,7 +290,7 @@ You must generate them using a dedicated process:
To avoid memory issues, we encourage you to also use the :code:`--limit` parameter of the command.
How to read the email sent by the program ?
How to read emails sent by the program ?
*******************************************
In development, there is a built-in "mail catcher". Open it with :code:`symfony open:local:webmail`
@ -298,7 +298,7 @@ In development, there is a built-in "mail catcher". Open it with :code:`symfony
How to run cron-jobs ?
**********************
Some command must be executed in :ref:`cron jobs <cronjob>`. To execute them:
Some commands must be executed in :ref:`cron jobs <cronjob>`. To execute them:
.. code-block:: bash
@ -307,18 +307,18 @@ Some command must be executed in :ref:`cron jobs <cronjob>`. To execute them:
What about materialized views ?
*******************************
There are some materialized views in chill, to speed up some complex computation on the database.
There are some materialized views in chill, to speed up some complex computations in the database.
In order to refresh them, run cron job or refresh them manually in your database.
In order to refresh them, run a cron job or refresh them manually in your database.
How to run tests for chill-bundles
**********************************
Tests reside inside the installed bundles. You must `cd` into that directory, download the required packages, and execute them from this place.
**Note**: some bundle require the fixture to be executed. See the dedicated _how-tos_.
**Note**: some bundles require the fixtures to be executed. See the dedicated _how-tos_.
Exemple, for running unit test inside `main` bundle:
Example, for running a unit test inside `main` bundle:
.. code-block:: bash
@ -344,16 +344,16 @@ Running in production
Currently, to run this software in production, the *state of the art* is the following :
1. Run the software locally and tweak the configuration to your needs ;
2. Build the image and store them into a private container registry.
2. Build the image and store it in a private container registry.
.. warning::
In production, you **must** set those variables:
In production, you **must** set these variables:
* ``APP_ENV`` to ``prod``
* ``APP_DEBUG`` to ``false``
There are security issues if you keep the same variable than for production.
There are security issues if you keep the same variables as for production.
Going further