diff options
Diffstat (limited to 'docs/en/developer')
-rw-r--r-- | docs/en/developer/console_commands.rst | 30 | ||||
-rw-r--r-- | docs/en/developer/front_end.rst | 33 |
2 files changed, 63 insertions, 0 deletions
diff --git a/docs/en/developer/console_commands.rst b/docs/en/developer/console_commands.rst new file mode 100644 index 00000000..85a8a092 --- /dev/null +++ b/docs/en/developer/console_commands.rst | |||
@@ -0,0 +1,30 @@ | |||
1 | Console Commands | ||
2 | ================ | ||
3 | |||
4 | wallabag has a number of CLI commands to manage a number of tasks. You can list all the commands by executing `bin/console` in the wallabag folder. | ||
5 | |||
6 | Each command has a help accessible through `bin/console help %command%`. | ||
7 | |||
8 | .. note:: | ||
9 | |||
10 | If you're in a production environment, remember to add `-e prod` to each command. | ||
11 | |||
12 | Notable commands | ||
13 | ---------------- | ||
14 | |||
15 | * `assets:install`: May be helpful if assets are missing. | ||
16 | * `cache:clear`: should be run after each update (included in `make update`). | ||
17 | * `doctrine:migrations:status`: Output the status of your database migrations. | ||
18 | * `fos:user:activate`: Manually activate an user. | ||
19 | * `fos:user:change-password`: Change a password for an user. | ||
20 | * `fos:user:create`: Create an user. | ||
21 | * `fos:user:deactivate`: Deactivate an user (not deleted). | ||
22 | * `fos:user:demote`: Removes a role from an user, typically admin rights. | ||
23 | * `fos:user:promote`: Adds a role to an user, typically admin rights. | ||
24 | * `rabbitmq:*`: May be useful if you're using RabbitMQ. | ||
25 | * `wallabag:clean-duplicates`: Removes all entry duplicates for one user or all users | ||
26 | * `wallabag:export`: Exports all entries for an user. You can choose the output path of the file. | ||
27 | * `wallabag:import`: Import entries to different formats to an user account. | ||
28 | * `wallabag:import:redis-worker`: Useful if you use Redis. | ||
29 | * `wallabag:install`: (re)Install wallabag | ||
30 | * `wallabag:tag:all`: Tag all entries for an user using his/her tagging rules. | ||
diff --git a/docs/en/developer/front_end.rst b/docs/en/developer/front_end.rst new file mode 100644 index 00000000..40f18a42 --- /dev/null +++ b/docs/en/developer/front_end.rst | |||
@@ -0,0 +1,33 @@ | |||
1 | Tips for front-end developers | ||
2 | ============================= | ||
3 | |||
4 | Starting from version 2.3, wallabag uses webpack to bundle its assets. | ||
5 | |||
6 | Dev mode | ||
7 | -------- | ||
8 | |||
9 | If the server runs in dev mode, you need to run ``yarn run build:dev`` to generate the outputted javascript files for each theme. These are named ``%theme%.dev.js`` and are ignored by git. You need to relaunch ``yarn run build:dev`` for each change made to one of the assets files (js, css, pictures, fonts,...). | ||
10 | |||
11 | Live reload | ||
12 | ----------- | ||
13 | |||
14 | Webpack brings support for live reload, which means you don't need to regenerate the assets file for each change neither reload the page manually. Changes are applied automatically in the web page. Just set the ``use_webpack_dev_server`` setting to ``true`` in ``app/config/config.yml`` and run ``yarn run watch`` and you're good to go. | ||
15 | |||
16 | .. note:: | ||
17 | |||
18 | Don't forget to put back ``use_webpack_dev_server`` to ``false`` when not using the live reload feature. | ||
19 | |||
20 | Production builds | ||
21 | ----------------- | ||
22 | |||
23 | When you want to commit your changes, build them in production environment by using ``yarn run build:prod``. This will build all the assets needed for wallabag. To test that it properly works, you'll need to have a server in production mode, for instance with ``bin/console server:run -e=prod``. | ||
24 | |||
25 | .. note:: | ||
26 | |||
27 | Don't forget to generate production builds before committing ! | ||
28 | |||
29 | |||
30 | Code style | ||
31 | ---------- | ||
32 | |||
33 | Code style is checked by two tools : stylelint for (S)CSS and eslint for JS. ESlint config is based on the Airbnb base preset. | ||