Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve phrasing on admin and development docs #191

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions en/admin/asynchronous.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
Asynchronous tasks
==================

In order to launch asynchronous tasks (useful for huge imports for
example), we can use RabbitMQ or Redis.
To launch asynchronous tasks (useful for large imports), we can use RabbitMQ or Redis.

Install RabbitMQ for asynchronous tasks
---------------------------------------
Expand Down
8 changes: 4 additions & 4 deletions en/admin/backup.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Backup wallabag

Because sometimes you may do a mistake with your wallabag and lose data
or in case you need to move your wallabag to another server you want to
backup your data. This articles describes what you need to backup.
If you make a mistake with your wallabag and lose data,
or you need to move your wallabag to another server, you'll want to
backup your data. This article describes what you need to backup.

## Basic settings

Expand All @@ -11,7 +11,7 @@ backend) in the file app/config/parameters.yml.

## Database

As wallabag supports different kinds of database, the way to perform the
As wallabag supports different kinds of databases, the way to perform the
backup depends on the database you use, so you need to refer to the
vendor documentation.

Expand Down
4 changes: 2 additions & 2 deletions en/admin/common_errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ Here is a list of common errors that we have seen in GitHub's issues.

## Migration script assumes quote table names are enabled for MySQL

If during migration you got some problems with MySQL with an error like that:
If during migration you experience problems with MySQL with an error like this:

> SQLSTATE[42000]: Syntax error or access violation: 1064 You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near '"wallabag_entry" ADD uuid LONGTEXT DEFAULT NULL' at line 1

It means you should enable the `ANSI_QUOTES` of `SQL_MODE`.
This means you should enable the `ANSI_QUOTES` of `SQL_MODE`.

You can do that in your `app/config/config.yml` file:

Expand Down
50 changes: 25 additions & 25 deletions en/admin/console_commands.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
Console Commands
================

wallabag has a number of CLI commands to manage a number of tasks. You
wallabag has a number of CLI commands to manage various tasks. You
can list all the commands by executing `bin/console` in the wallabag
folder.

Each command has a help accessible through `bin/console help %command%`.
Each command has help accessible through `bin/console help %command%`.

> If you're in a production environment, remember to add `--env=prod` to each
command.
Expand All @@ -16,29 +16,29 @@ Notable commands
From Symfony:

- `assets:install`: May be helpful if assets are missing.
- `cache:clear`: should be run after each update (included in make update).
- `doctrine:migrations:status`: Output the status of your database migrations.
- `fos:user:activate`: Manually activate a user.
- `fos:user:change-password`: Change a password for a user.
- `fos:user:create`: Create a user.
- `fos:user:deactivate`: Deactivate a user (not deleted).
- `cache:clear`: Should be run after each update (included in make update).
- `doctrine:migrations:status`: Outputs the status of your database migrations.
- `fos:user:activate`: Manually activates a user.
- `fos:user:change-password`: Changes a password for a user.
- `fos:user:create`: Creates a user.
- `fos:user:deactivate`: Deactivates a user (not deleted).
- `fos:user:demote`: Removes a role from a user, typically admin rights.
- `fos:user:promote`: Adds a role to a user, typically admin rights.
- `rabbitmq:*`: May be useful if you're using RabbitMQ.

Custom to wallabag:

- `wallabag:clean-downloaded-images`: Cleans downloaded images which are no more associated to an entry
- `wallabag:clean-duplicates`: Removes all entry duplicates for one user or all users
- `wallabag:entry:reload`: Reload entries.
- `wallabag:clean-downloaded-images`: Cleans downloaded images which are no longer associated with an entry.
- `wallabag:clean-duplicates`: Removes all entry duplicates for one user or all users.
- `wallabag:entry:reload`: Reloads entries.
- `wallabag:export`: Exports all entries for a user. You can choose the output path of the file.
- `wallabag:generate-hashed-urls`: Generates hashed urls for each entry
- `wallabag:import`: Import entries to different formats to a user account.
- `wallabag:generate-hashed-urls`: Generates hashed URLs for each entry.
- `wallabag:import`: Imports entries in different formats to a user account.
- `wallabag:import:redis-worker`: Useful if you use Redis.
- `wallabag:install`: (re)Install wallabag
- `wallabag:tag:all`: Tag all entries for a user using his/her tagging rules.
- `wallabag:install`: (re)Installs wallabag.
- `wallabag:tag:all`: Tags all entries for a user using their tagging rules.
- `wallabag:user:show`: Shows the details for a user.
- `wallabag:user:list`: List all existing users.
- `wallabag:user:list`: Lists all existing users.

wallabag:clean-downloaded-images
-------------------------
Expand All @@ -58,7 +58,7 @@ Options:
wallabag:clean-duplicates
-------------------------

This command helps you to clean your articles list in case of duplicates.
This command helps you clean your articles list in case of duplicates.

Usage:

Expand All @@ -74,7 +74,7 @@ Arguments:
wallabag:entry:reload
---------------------

This command reload entries.
This command reloads entries.

Usage:

Expand All @@ -89,7 +89,7 @@ Arguments:
wallabag:export
---------------

This command helps you to export all entries for a user.
This command helps you export all entries for a user.

Usage:

Expand All @@ -106,7 +106,7 @@ Arguments:
wallabag:generate-hashed-urls
---------------

This command helps you to generates hashes of the url of each entry, to check through API if an URL is already saved. Only available since 2.4.0.
This command helps you generate hashes of the URL of each entry to check through the API if a URL is already saved. Only available since 2.4.0.

Usage:

Expand All @@ -122,7 +122,7 @@ Arguments:
wallabag:import
---------------

This command helps you to import entries from a JSON export.
This command helps you import entries from a JSON export.

Usage:

Expand All @@ -146,7 +146,7 @@ Options:
wallabag:import:redis-worker
----------------------------

This command helps you to launch Redis worker.
This command helps you launch Redis worker.

Usage:

Expand All @@ -166,7 +166,7 @@ Options:
wallabag:install
----------------

This command helps you to install or re-install wallabag.
This command helps you install or re-install wallabag.

Usage:

Expand All @@ -178,7 +178,7 @@ wallabag:install
wallabag:tag:all
----------------

This command helps you to tag all entries using tagging rules.
This command helps you tag all entries using tagging rules.

Usage:

Expand Down Expand Up @@ -217,7 +217,7 @@ wallabag:user:list [<search>]
```

Arguments:
- search: Filter the list with the given search term. The search is done on users' username, name and email
- search: Filter the list with the given search term. The search is done on users' username, name, and email

Options:
- `--limit=LIMIT`: Max number of users displayed in the list
8 changes: 4 additions & 4 deletions en/admin/custom_css.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@ Custom CSS
==========

{% hint style="tip" %}
Available since 2.4.0 version.
Available since version 2.4.0.
{% endhint %}

You can apply some custom styles to your wallabag instance.
You can apply custom styles to your wallabag instance.

1. Create a file named `custom.css` in the `web/` directory
2. Put whatever CSS you want inside and it'll be automatically loaded on each wallabag page
2. Put any CSS you want inside. It'll be automatically loaded on each wallabag page

Keep in mind that this option is instance wide and can't be adjusted per user.
This option is instance-wide and can't be adjusted per user.
6 changes: 3 additions & 3 deletions en/admin/installation/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,19 @@ To install wallabag easily, we provide a `Makefile`, so you need to have the `ma
wallabag uses a large number of PHP libraries.
These libraries must be installed with a tool called **Composer**.

Check that the installed version is at least the 1.8.0:
Check that the installed version is at least 1.8.0:

composer --version

If not, try to upgrade it using

composer selfupdate

If that command isn't recognized, please, [re-install it](https://getcomposer.org/doc/00-intro.md).
If that command isn't recognized, please [re-install it](https://getcomposer.org/doc/00-intro.md).

## PHP Extensions

You'll also need the following extensions. Some of these may already activated, so you may not have to install all corresponding packages.
You'll also need the following extensions. Some of these may already be activated, so you may not have to install all corresponding packages.

- php-session
- php-ctype
Expand Down
18 changes: 9 additions & 9 deletions en/admin/installation/rightaccess.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,25 @@

When we just want to test wallabag, we just run the command `make run`
to start our wallabag instance and everything will go smoothly because
the user who started the project can access to the current folder
the user who started the project can access the current folder
naturally, without any problem.

### Production environment

As soon as we use Apache or Nginx to access to our wallabag instance,
and not from the command `make run` to start it, we should take care to
grant the good rights on the good folders to keep safe all the folders
of the project.
As soon as we use Apache or Nginx to access our wallabag instance,
and not the command `make run` to start it, we should take care to
grant the correct rights on the correct folders to keep all the folders
of the project safe.

To do so, the folder name, known as `DocumentRoot` (for apache) or
To do so, the folder name, known as `DocumentRoot` (for Apache) or
`root` (for Nginx), has to be absolutely accessible by the Apache/Nginx
user. Its name is generally `www-data`, `apache` or `nobody` (depending
on linux system used).
user. Its name is generally `www-data`, `apache`, or `nobody` (depending
on the Linux system used).

So the folder `/var/www/wallabag/web` has to be accessible by this last
one. But this may not be enough if we just care about this folder,
because we could meet a blank page or get an error 500 when trying to
access to the homepage of the project.
access the homepage of the project.

This is due to the fact that we will need to grant the same rights
access on the folder `/var/www/wallabag/var` like those we gave on the
Expand Down
14 changes: 7 additions & 7 deletions en/admin/internal_settings.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# What are the internal settings for?

The internal settings page is only available for the instance administrator. It allows to handle more sensible settings, such as activating some features.
The internal settings page is only available for the instance administrator. It allows handling more sensitive settings, such as activating specific features.

## Analytics

Expand Down Expand Up @@ -42,9 +42,9 @@ URL Shaarli instance.

`1` to show the share button for email, `0` to deactivate.

### Allow public url for entries
### Allow public URL for entries

`1` to allow to publicly share articles, `0` to deactivate.
`1` to allow publicly sharing articles, `0` to deactivate.

### Enable share to Shaarli

Expand Down Expand Up @@ -122,14 +122,14 @@ Username of the account used for demo.

### Download images locally

`1` to activate local pictures downloading, `0`, to deactivate.
`1` to activate local picture downloading, `0` to deactivate.

Once this feature is activated, the articles pictures will be downloaded in the `/web/assets/images` folder of your wallabag instance. The path of pictures in articles will also be updated to the path of pictures which are on your instance.
Once this feature is activated, the article pictures will be downloaded in the `/web/assets/images` folder of your wallabag instance. The path of pictures in articles will also be updated to the path of pictures which are on your instance.

{% hint style="tip" %}
If you want GIFs to keep animation, install `imagick` PHP extension. It's mostly available through distros packet management as `php-imagick`.
If you want GIFs to keep animation, install the `imagick` PHP extension. It's mostly available through distros packet management as `php-imagick`.
{% endhint %}

### Support URL for wallabag

URL used in emails sent by wallabag for any help request.
URL used in emails sent by wallabag for help requests.
6 changes: 3 additions & 3 deletions en/admin/mailer.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Since 2.6.6, the `gmail` transport is available again using the DSN: `gmail+smtp
| -----|-------------|-------- |
| mailer_dsn | One liner with all the mailer parameters `smtp://user:pass@host:465`. Any characters considered special need to be urlencoded in `user`, `pass` and `host`. | smtp://127.0.0.1 |

note: In a case, that after supplying urlencoded characters, the start up process crashes, try "escaping" them with additional % character:
eg. pass%20word -> pass%%20word. Might be useful for Google App Passwords.
note: In the event that supplying URL-encoded characters causes the startup process to crash, try "escaping" them with an additional % character:
e.g., pass%20word -> pass%%20word. This might be useful for Google App Passwords.

{% hint style="tip" %}
Symfony can support other transports which aren't shipped by default with wallabag: Amazon SES, MailChimp, Mailgun, Postmark & SendGrid.
Expand All @@ -23,7 +23,7 @@ You can install them using Composer. It's a more complex step to do, [check the

On wallabag < 2.6.1, the mailer was different (we were using an older version of Symfony).

Here are the previous parameters available.
Here are the previously available parameters.

| Name | Description | Default |
| -----|-------------|-------- |
Expand Down
4 changes: 2 additions & 2 deletions en/admin/parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

## Default parameters.yml file

Here is the last version of the default app/config/parameters.yml file.
Be sure that yours respects this one. If you don't know which value you
Here is the latest version of the default app/config/parameters.yml file.
Be sure that yours matches this one. If you don't know which value you
need to set, please leave the default one.

{% hint style="tip" %}
Expand Down
Loading