Merge pull request #13 from crowdsecurity/doc_imp

minor typos or suggestions in doc

Author: mobula9

docs/contribute.md

@@ -1,6 +1,6 @@
 # Contribute to this plugin
 
-> Before all, be sure to [get the stack installed using the docker-compose guide](install-with-docker-compose.md).
+> First, be sure to [get the stack installed using the docker-compose guide](install-with-docker-compose.md).
 # Play with crowdsec state
 
 ```bash
@@ -32,7 +32,7 @@ docker-compose run --rm wpscan --url http://wordpress5-6/
 docker-compose exec wordpress5-6 composer install --working-dir /var/www/html/wp-content/plugins/cs-wordpress-bouncer --prefer-source
 ```
 
-> In this dev environment, we use `--prefer-source` to be able to develop the bouncer library at the same time. Composer will may ask you for your own Github token to download sources instead of using dist packages.
+> In this dev environment, we use `--prefer-source` to be able to develop the bouncer library at the same time. Composer may ask you for your own Github token to download sources instead of using dist packages.
 
 
 ### Quick `docker-compose` cheet sheet
@@ -68,13 +68,13 @@ Then re-run the stack.
 
 ### Try the plugin with another WordPress version
 
-In start of 2021, [more than 90% of the wordpress websites](https://wordpress.org/about/stats/) was using WordPress versions:
 
 The plugin is tested under each of these WordPress versions: `5.6`, `5.5`, `5.4`, `5.3`, `5.2`, `5.1`, `5.0`, `4.9`.
+(Representing [more than 90% of the wordpress websites](https://wordpress.org/about/stats/))
 
 #### Add support for a new WordPress version
 
-This is a sheet cheet to help testing briefly the support:
+This is a cheat sheet to help testing briefly the support:
 
 ```bash
 
@@ -94,11 +94,11 @@ docker-compose down && docker rmi wordpress-bouncer_wordpress<X.X>
 docker-compose run wordpress<X.X> bash
 ```
 
-> Note: The `DOCKER_HOST_IP` environnment variable is initialized via `source ./load-env-vars.sh`.
+> Note: The `DOCKER_HOST_IP` environnement variable is initialized via `source ./load-env-vars.sh`.
 
 ### Plugin debug mode VS production mode
 
-The debug mode throw verbose errors. The production hide every error to let users navigate in every edge cases.
+The debug mode throws verbose errors. The production mode hides every error to let users navigate in every edge cases.
 
 This plugin goes in debug mode when Wordpress debug mode is enabled.
 
@@ -107,9 +107,9 @@ To try the production mode of this plugin, just disable the wordpress debug mode
     WORDPRESS_DEBUG: 1 # Comment this line the simulate the production mode
 ```
 
-#### Test linux behaviour from OSX or Windows
+#### Test Linux behavior from OSX or Windows
 
-You can test the Linux behaviour of this project using **Vagrant**.
+You can test the Linux behavior of this project using **Vagrant**.
 
 ```bash
 vagrant up

docs/full-guide.md

@@ -1,12 +1,12 @@
 # Full guide
 
-This scenario exposes you the main features this plugin is capable of.
+This guide exposes you the main features of the plugin.
 
-## Let's get starting!
+## Let's get started!
 
 We will start using "live" mode. You'll understand what it is after try the stream mode.
 
-* Before all, be sure to [get the stack installed using the docker-compose guide](install-with-docker-compose.md).
+* First, be sure to [get the stack installed using the docker-compose guide](install-with-docker-compose.md).
 
 * open a terminal to display LAPI logs in realtime:
 
@@ -16,33 +16,33 @@ docker-compose logs -f crowdsec
 
 * In wp-admin, [ensure the bouncer is configured with **live** mode](http://localhost:8050/wp-admin/admin.php?page=crowdsec_plugin) (stream mode disabled).
 
-### Discove the cache system
+### Discover the cache system
 
-* In a tab, visit the [public home](http://localhost:8050/). The way is free because LAPI said your IP is clean.
+* In a tab, visit the [public home](http://localhost:8050/). You're allowed because LAPI said your IP is clean.
 
 > To avoid latencies when the clean IP browse the website, the bouncer will keep this information in cache for 30 seconds (you can change this value in the [avdanced settings page](http://localhost:8050/wp-admin/admin.php?page=crowdsec_advanced_settings)). In other words, LAPI will not be requested to check this IP for the next 30 seconds.
 
- * You can call the website many time as you want, the cache system will take relay during the ban period and so LAPI will not be disturbed. The ban decision will stay in cache for the full ban duration. Then the [public home](http://localhost:8050/) should be available again.
+ * You can call the website as many times as you want, the cache system will take relay during the ban period and so LAPI will not be disturbed. The ban decision will stay in cache for the full ban duration. Then the [public home](http://localhost:8050/) should be available again.
 
  ### Try ban remediation
 
-* As we don't want this delay, to take in account immediately the last unban, feel free to [clear the cache in the wp-admin](http://localhost:8050/wp-admin/admin.php?page=crowdsec_plugin).
+* If you want to skip this delay, feel free to [clear the cache in the wp-admin](http://localhost:8050/wp-admin/admin.php?page=crowdsec_plugin).
 
-The `DOCKER_HOST_IP` environnment variable is initialized via a call to:
+The `DOCKER_HOST_IP` environnement variable is initialized via a call to:
 
 ```bash
 source ./load-env-vars.sh
 ```
 
-* In a term, ban your own IP for 4 hours:
+* In a terminal, ban your own IP for 4 hours:
 
 ```bash
 
 # Ban your own IP for 4 hours:
 docker-compose exec crowdsec cscli decisions add --ip ${DOCKER_HOST_IP} --duration 4h --type ban
 ```
 
-* Immediately, the [public home](http://localhost:8050/) is now locked with a short message to explain you that you were ban.
+* Immediately, the [public home](http://localhost:8050/) is now locked with a short message to explain you that you are banned.
 
 ### Try "captcha" remediation
 
@@ -60,18 +60,18 @@ docker-compose exec crowdsec cscli decisions add --ip ${DOCKER_HOST_IP} --durati
 
 * The [public home](http://localhost:8050/) now request you to fill a captcha.
 
-* While you fail resolving the captcha, you'll not be able to access the website.
+* Unless you manage to solve the captcha, you'll not be able to access the website.
 
 > Note: when you resolve the captcha in your browser, the associated PHP session is considered as sure.
-> If you remove the captcha decision with `cscli`, then you add a new captcha decision for your IP, you'll not be prompted no more for the current PHP session. To view the captcha page, You can force using a new PHP session opening the front page with incognito mode.
+> If you remove the captcha decision with `cscli`, then you add a new captcha decision for your IP, you'll not be prompted for the current PHP session. To view the captcha page, You can force using a new PHP session opening the front page with incognito mode.
 
 ## Stream mode, for the high traffic websites
 
-With live mode, as you tried it just before, each time a user arrives to the website for the first time, a called is made to LAPI. If the traffic on your website is high, the bouncer will call LAPI very often.
+With live mode, as you tried it just before, each time a user arrives to the website for the first time, a call is made to LAPI. If the traffic on your website is high, the bouncer will call LAPI very often.
 
-To avoid this, LAPI offers a "stream" mode. The whole decisions list is updated for a predefined frequency. Let's try it!
+To avoid this, LAPI offers a "stream" mode. The decisions list is updated at a predefined frequency and kept in cache. Let's try it!
 
-> This bouncer used the WordPress cron system. For this demo purpose, we encourage you to [install the WP-Control plugin](http://localhost:8050/wp-admin/plugin-install.php?s=wp-control&tab=search&type=term), a plugin to view and control each Wordpress Cron task jobs.
+> This bouncer uses the WordPress cron system. For demo purposes, we encourage you to [install the WP-Control plugin](http://localhost:8050/wp-admin/plugin-install.php?s=wp-control&tab=search&type=term), a plugin to view and control each Wordpress Cron task jobs.
 
 First, clear the previous decisions:
 
@@ -82,7 +82,7 @@ docker-compose exec crowdsec cscli decisions delete --all
 
 * Then enable "stream" mode [right here](http://localhost:8050/wp-admin/admin.php?page=crowdsec_advanced_settings) and set the resync frequency to 30 seconds. If you installed WP-Control plugin, you can see that a new cron tak has just been added here http://localhost:8050/wp-admin/tools.php?page=crontrol_admin_manage_page.
 
-* As the whole blocklist has just been loaded in cache (0 decision!), your IP is now free. The [public home](http://localhost:8050/) is now available.
+* As the whole blocklist has just been loaded in cache (0 decision!), your IP is allowed. The [public home](http://localhost:8050/) is available.
 
 * Now, if you ban your IP for 4h:
 
@@ -92,13 +92,13 @@ docker-compose exec crowdsec cscli decisions add --ip ${DOCKER_HOST_IP} --durati
 
 * In less than 30 seconds your IP will be banned and the [public home](http://localhost:8050/) will be locked.
 
-Conclusion: with the stream mode, LAPI is never call directly when the website user arrives for the first time.
+Conclusion: with the stream mode, LAPI decisions are fetched on a regular basis rather than being called when user arrives for the first time.
 
 # Try Redis or Memcached
 
 In order to get better performances, you can switch the cache technology.
 
-The docker-compose file started 2 container not used until now, redis and memcached.
+The docker-compose file started 2 unused containers, redis and memcached.
 
 Let's try **Redis**!
 
@@ -118,4 +118,4 @@ Very similar with **Memcached**!
 The bouncer has a stats page indicating each time :
 - an IP has been banned by your website, or
 - when a captcha has been presented to an IP visiting your website
-- when a captcha the captcha has been solved or not.
+- when a captcha has been solved or not.

docs/install-with-docker-compose.md

@@ -15,7 +15,7 @@ Before all, create a `.env` file, using:
 cp .env.example .env
 ```
 
-> Note about PHP 8.0: WordPress official docker image [does not officially supports PHP 8.0](https://hub.docker.com/_/wordpress?tab=tags&page=1&ordering=last_updated) at this time. However, as the CrowdSec PHP Library does support PHP 8.0, there is a good chance that the pluggin will work fine with PHP 8.0, but we can not currently test it.
+> Note about PHP 8.0: WordPress official docker image [does not officially supports PHP 8.0](https://hub.docker.com/_/wordpress?tab=tags&page=1&ordering=last_updated) at this time. However, as the CrowdSec PHP Library does support PHP 8.0, there is a good chance that the plugin will work fine with PHP 8.0, but we can not currently test it.
 
 ## Configure WordPress and the CrowdSec Plugin
 
@@ -51,7 +51,7 @@ The LAPI URL is:
 
 http://crowdsec:8080
 
-## Try the plugin behaviour
+## Try the plugin behavior
 
 | Info            | Value                                |
 |-----------------|--------------------------------------|