diff options
| author | 2020-04-16 18:08:53 +0200 | |
|---|---|---|
| committer | 2020-04-16 18:08:53 +0200 | |
| commit | 475feffdbec733b3d3221276217692bed5f8f090 (patch) | |
| tree | 24395201a6f81fab09d06c6be9703f43090d9024 | |
| parent | 946d9f5535ddc62fb667edd27e57bde419586e23 (diff) | |
Markdownlint (#2880)
* markdownlint
I have started to use
[markdownlint](https://github.com/DavidAnson/markdownlint/) to find
typos in Markdown. Let's discuss which rules to enforce / disable /
customize
* markdownlint cli/readme
| -rw-r--r-- | .markdownlint.json | 16 | ||||
| -rw-r--r-- | CHANGELOG.md | 11 | ||||
| -rw-r--r-- | CONTRIBUTING.md | 10 | ||||
| -rw-r--r-- | cli/README.md | 10 |
4 files changed, 33 insertions, 14 deletions
diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 000000000..ad37f178e --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,16 @@ +{ + "default": true, + "first-line-heading": false, + "line-length": false, + "no-hard-tabs": false, + "no-inline-html": { + "allowed_elements": [ "kbd" ] + }, + "no-multiple-blanks": { + "maximum": 2 + }, + "ul-indent": false, + "ul-style": { + "style": "consistent" + } +} diff --git a/CHANGELOG.md b/CHANGELOG.md index c5cce8c05..6b04c4a7e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -825,6 +825,7 @@ ## 2016-07-23 FreshRSS 1.4.0 + ## 2016-06-12 FreshRSS 1.3.2-beta * Compatibility @@ -987,7 +988,7 @@ ## 2015-01-15 FreshRSS 0.9.4 (beta) * Feature - * Extension system (!!): some extensions are available at https://github.com/FreshRSS/Extensions + * Extension system (!!): some extensions are available at [github.com/FreshRSS/Extensions](https://github.com/FreshRSS/Extensions) * Refactoring * Front controller (FreshRSS class) * Configuration system @@ -1127,8 +1128,8 @@ * API compatible with Google Reader API level 2 * FreshRSS can now be used from e.g.: - * (Android) News+ https://play.google.com/store/apps/details?id=com.noinnion.android.newsplus.extension.google_reader - * (Android) EasyRSS https://github.com/Alkarex/EasyRSS + * (Android) [News+](https://play.google.com/store/apps/details?id=com.noinnion.android.newsplus.extension.google_reader) + * (Android) [EasyRSS](https://github.com/Alkarex/EasyRSS) * Basic support for audio and video podcasts * Searching * New search filters date: and pubdate: accepting ISO 8601 date intervals such as `date:2013-2014` or `pubdate:P1W` @@ -1257,10 +1258,10 @@ * Les images, CSS, scripts sont servis sans cookie * Utilise “HttpOnly” pour plus de sécurité * Nouvel “agent utilisateur” exposé lors du téléchargement des flux, par exemple : - * “FreshRSS/0.7 (Linux; http://freshrss.org) SimplePie/1.3.1” + * `FreshRSS/0.7 (Linux; http://freshrss.org) SimplePie/1.3.1` * Script d’actualisation avec plus de messages * Sur la sortie standard, ainsi que dans le log système (syslog) - * Affichage du numéro de version dans "À propos" + * Affichage du numéro de version dans “À propos” ## 2013-11-21 FreshRSS 0.6.1 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bc33c2ef6..c673eac96 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# How to contribute to FreshRSS? +# How to contribute to FreshRSS ## Chat with us @@ -19,10 +19,10 @@ If you have to create a new ticket, try to apply the following advices: - Give an explicit title to the ticket so it will be easier to find it later. - Be as exhaustive as possible in the description: what did you do? What is the bug? What are the steps to reproduce the bug? - We also need some information: - + Your FreshRSS version (on about page or `constants.php` file) - + Your server configuration: type of hosting, PHP version - + Your storage system (SQLite, MySQL, MariaDB, PostgreSQL) - + If possible, the related logs (PHP logs and FreshRSS logs under `data/users/your_user/log.txt`) + - Your FreshRSS version (on about page or `constants.php` file) + - Your server configuration: type of hosting, PHP version + - Your storage system (SQLite, MySQL, MariaDB, PostgreSQL) + - If possible, the related logs (PHP logs and FreshRSS logs under `data/users/your_user/log.txt`) ## Fix a bug diff --git a/cli/README.md b/cli/README.md index b4112bf63..1e9e72d4d 100644 --- a/cli/README.md +++ b/cli/README.md @@ -86,19 +86,21 @@ cd /usr/share/FreshRSS # Optimize database (reduces the size) for a given user (perform `OPTIMIZE TABLE` in MySQL, `VACUUM` in SQLite) ``` -#### Note about cron +### Note about cron Some commands display informations on standard error, cron will send an email with thoses informations every time the command will be executed (exited zero or non-zero). To avoid cron sending email on success: + ```sh @daily /usr/local/bin/my-command > /var/log/cron-freshrss-stdout.log 2>/var/log/cron-freshrss-stderr.log || cat /var/log/cron-freshrss-stderr.log ``` Explanations: -- _/usr/local/bin/my-command > /var/log/cron-freshrss-stdout.log_ : redirect the standard output to a log file -- _/usr/local/bin/my-command 2> /var/log/cron-freshrss-stderr.log_ : redirect the standard error to a log file -- _|| cat /var/log/cron-freshrss-stderr.log_ : if the exit code of _/usr/local/bin/my-command_ is non-zero, then it send by mail the content error file. + +* `/usr/local/bin/my-command > /var/log/cron-freshrss-stdout.log`_ : redirect the standard output to a log file +* `/usr/local/bin/my-command 2> /var/log/cron-freshrss-stderr.log` : redirect the standard error to a log file +* `|| cat /var/log/cron-freshrss-stderr.log_ : if the exit code of _/usr/local/bin/my-command` is non-zero, then it send by mail the content error file. Now, cron will send you an email only if the exit code is non-zero and with the content of the file containing the errors. |
