aboutsummaryrefslogtreecommitdiff
path: root/docs/en/developers
diff options
context:
space:
mode:
authorGravatar Alexandre Alapetite <alexandre@alapetite.fr> 2022-01-08 21:58:55 +0100
committerGravatar GitHub <noreply@github.com> 2022-01-08 21:58:55 +0100
commit1acd3ab09be1b65bfd6122ee351490c3b5527bb8 (patch)
treef11de558e7a09522a45d1c155d9707ecda6bf1eb /docs/en/developers
parent916df412f5b6f7fb9bcfb705a3c8c23e35304410 (diff)
Use typographic quotes (#4133)
* Use typographic quotes * A few fixes * Fix * Fix not saved * Implement feedback * Detail * Revert spoken English fixes Left for a future dedicated discussion * More reverts * Final reverts * Final minor
Diffstat (limited to 'docs/en/developers')
-rw-r--r--docs/en/developers/01_Index.md2
-rw-r--r--docs/en/developers/02_First_steps.md22
-rw-r--r--docs/en/developers/02_Github.md2
-rw-r--r--docs/en/developers/03_Backend/05_Extensions.md18
-rw-r--r--docs/en/developers/03_Running_tests.md2
-rw-r--r--docs/en/developers/04_Frontend/02_Design.md4
-rw-r--r--docs/en/developers/04_Pull_requests.md26
-rw-r--r--docs/en/developers/05_Release_new_version.md28
-rw-r--r--docs/en/developers/06_Fever_API.md4
-rw-r--r--docs/en/developers/06_GoogleReader_API.md2
-rw-r--r--docs/en/developers/06_Reporting_Bugs.md26
11 files changed, 68 insertions, 68 deletions
diff --git a/docs/en/developers/01_Index.md b/docs/en/developers/01_Index.md
index 28d11a6cc..c32c1d4d7 100644
--- a/docs/en/developers/01_Index.md
+++ b/docs/en/developers/01_Index.md
@@ -2,7 +2,7 @@
## First Steps
-Start by creating your development environment. A guide to setting up FreshRSS's development environment can be found on [the appropriate page](02_First_steps.md).
+Start by creating your development environment. A guide to setting up FreshRSS’s development environment can be found on [the appropriate page](02_First_steps.md).
## After That
diff --git a/docs/en/developers/02_First_steps.md b/docs/en/developers/02_First_steps.md
index 626ee84fc..e79d86691 100644
--- a/docs/en/developers/02_First_steps.md
+++ b/docs/en/developers/02_First_steps.md
@@ -1,16 +1,16 @@
# Environment configuration (Docker)
-FreshRSS is built with PHP and uses a homemade framework, Minz. The dependencies are directly included in the source code, so you don't need Composer.
+FreshRSS is built with PHP and uses a homemade framework, Minz. The dependencies are directly included in the source code, so you don’t need Composer.
-There are various ways to configure your development environment. The easiest and most supported method is based on Docker, which is the solution documented below. If you already have a working PHP environment, you probably don't need it.
+There are various ways to configure your development environment. The easiest and most supported method is based on Docker, which is the solution documented below. If you already have a working PHP environment, you probably don’t need it.
-We assume here that you use a GNU/Linux distribution, capable of running Docker. Otherwise, you'll have to adapt the commands accordingly.
+We assume here that you use a GNU/Linux distribution, capable of running Docker. Otherwise, you’ll have to adapt the commands accordingly.
-The commands that follow have to be executed in a console. They start by `$` when commands need to be executed as normal user, and by `#` when they need to be executed as root user. You don't have to type these characters. A path may be indicated before these characters to help you identify where they need to be executed. For instance, `app$ echo 'Hello World'` indicates that you have to execute `echo` command in the `app/` directory.
+The commands that follow have to be executed in a console. They start by `$` when commands need to be executed as normal user, and by `#` when they need to be executed as root user. You don’t have to type these characters. A path may be indicated before these characters to help you identify where they need to be executed. For instance, `app$ echo 'Hello World'` indicates that you have to execute `echo` command in the `app/` directory.
First, you need to install [Docker](https://docs.docker.com/install/linux/docker-ce/ubuntu/).
-Once you're done, clone the repository with:
+Once you’re done, clone the repository with:
```sh
git clone https://github.com/FreshRSS/FreshRSS.git
@@ -25,7 +25,7 @@ Then, the only command you need to know is the following:
make start
```
-This might take some time while Docker downloads the image. If your user isn't in the `docker` group, you'll need to prepend the command with `sudo`.
+This might take some time while Docker downloads the image. If your user isn’t in the `docker` group, you’ll need to prepend the command with `sudo`.
**You can now access FreshRSS at [http://localhost:8080](http://localhost:8080).** Just follow the install process and select the SQLite database.
@@ -35,7 +35,7 @@ You can stop the containers by typing <kbd>Control</kbd> + <kbd>c</kbd> or with
make stop
```
-If you're interested in the configuration, the `make` commands are defined in the [`Makefile`](/Makefile).
+If you’re interested in the configuration, the `make` commands are defined in the [`Makefile`](/Makefile).
If you need to use a different tag image (default is `alpine`), you can set the `TAG` environment variable:
@@ -65,9 +65,9 @@ If you want to create your own FreshRSS extension, take a look at the [extension
## Coding style
-If you want to contribute to the source code, it's important to follow the project's coding style. The actual code doesn't always follow it throughout the project, but we should fix it every time an opportunity presents itself.
+If you want to contribute to the source code, it’s important to follow the project’s coding style. The actual code doesn’t always follow it throughout the project, but we should fix it every time an opportunity presents itself.
-Contributions which don't follow the coding style will be rejected as long as the coding style is not fixed.
+Contributions which don’t follow the coding style will be rejected as long as the coding style is not fixed.
## Spaces, tabs and other whitespace characters
@@ -119,7 +119,7 @@ echo $a ? 1 : 0;
### Parentheses
-There should be no spaces in between brackets. There should be no spaces before the opening bracket, except if it's after a keyword. There shouldn't be any spaces after the closing bracket, except if it's followed by a curly bracket.
+There should be no spaces in between brackets. There should be no spaces before the opening bracket, except if it’s after a keyword. There shouldn’t be any spaces after the closing bracket, except if it’s followed by a curly bracket.
```php
if ($a == 10) {
@@ -133,7 +133,7 @@ if ((int)$a == 10) {
### With chained functions
-It happens most of the time in Javascript files. When there are chained functions with closures and callback functions, it's hard to understand the code if not properly formatted. In those cases, we add a new indent level for the complete instruction and reset the indent for a new instruction on the same level.
+It happens most of the time in Javascript files. When there are chained functions with closures and callback functions, it’s hard to understand the code if not properly formatted. In those cases, we add a new indent level for the complete instruction and reset the indent for a new instruction on the same level.
```javascript
// First instruction
diff --git a/docs/en/developers/02_Github.md b/docs/en/developers/02_Github.md
index 7a7769caa..4e6a84ab3 100644
--- a/docs/en/developers/02_Github.md
+++ b/docs/en/developers/02_Github.md
@@ -4,7 +4,7 @@
If you are new to Git, here are some of the resources you might find useful:
-* [GitHub's blog post](https://github.com/blog/120-new-to-git)
+* [GitHub’s blog post](https://github.com/blog/120-new-to-git)
* <http://try.github.com/>
* <http://sixrevisions.com/resources/git-tutorials-beginners/>
* <http://rogerdudler.github.io/git-guide/>
diff --git a/docs/en/developers/03_Backend/05_Extensions.md b/docs/en/developers/03_Backend/05_Extensions.md
index 90fe6f699..d58521799 100644
--- a/docs/en/developers/03_Backend/05_Extensions.md
+++ b/docs/en/developers/03_Backend/05_Extensions.md
@@ -26,7 +26,7 @@ Note: it is quite conceivable that the functionalities of an extension can later
**TODO** : move to 02_Minz.md
-This data sheet should refer to the official FreshRSS and Minz documentation (the PHP framework on which FreshRSS is based). Unfortunately, this documentation does not yet exist. In a few words, here are the main things you should know. It is not necessary to read all the chapters in this section if you don't need to use a feature in your extension (if you don't need to translate your extension, no need to know more about the `Minz_Translate` module for example).
+This data sheet should refer to the official FreshRSS and Minz documentation (the PHP framework on which FreshRSS is based). Unfortunately, this documentation does not yet exist. In a few words, here are the main things you should know. It is not necessary to read all the chapters in this section if you don’t need to use a feature in your extension (if you don’t need to translate your extension, no need to know more about the `Minz_Translate` module for example).
### MVC Architecture
@@ -214,13 +214,13 @@ This part [is explained here](/docs/en/internationalization.md).
## Write an extension for FreshRSS
-Here we are! We've talked about the most useful features of Minz and how to run FreshRSS correctly and it's about time to address the extensions themselves.
+Here we are! We’ve talked about the most useful features of Minz and how to run FreshRSS correctly and it’s about time to address the extensions themselves.
An extension allows you to easily add functionality to FreshRSS without having to touch the core of the project directly.
### Make it work in Docker
-When working on an extension, it's easier to see it working directly in its environment. With Docker, you can leverage the use of the ```volume``` option when starting the container. Hopefully, you can use it without Docker-related knowledge by using the Makefile rule:
+When working on an extension, it’s easier to see it working directly in its environment. With Docker, you can leverage the use of the ```volume``` option when starting the container. Hopefully, you can use it without Docker-related knowledge by using the Makefile rule:
```sh
make start extensions="/full/path/to/extension/1 /full/path/to/extension/2"
```
@@ -266,7 +266,7 @@ In addition, it is good to have a `LICENSE` file indicating the license under wh
The `metadata.json` file defines your extension through a number of important elements. It must contain a valid JSON array containing the following entries:
* `name`: the name of your extension
-* `author`: your name, your e-mail address ... but there is no specific format to adopt
+* `author`: your name, your e-mail address … but there is no specific format to adopt
* `description`: a description of your extension
* `version`: the current version number of the extension
* `entrypoint`: Indicates the entry point of your extension. It must match the name of the class contained in the file `extension.php` without the suffix `Extension`
@@ -291,11 +291,11 @@ It must define some key elements to be loaded by the extension system:
1. The class must define the `init` method. This method is called **only** if the extension is loaded. Its purpose is to initialize the extension and its behavior during every page load.
The `Minz_Extension` abstract class defines a set of methods that can be overridden to fit your needs:
-* the `install` method is called when the user enables the extension in the configuration page. It must return _true_ when successful and a string containing an error message when not. Its purpose is to prepare FreshRSS for the extension (adding a table to the database, creating a folder tree, ...).
-* the `uninstall` method is called when the user disables the extension in the configuration page. It must return _true_ when successful and a string containing an error message when not. Its purpose is to clean FreshRSS (removing a table from the database, deleting a folder tree, ...). Usually it reverts changes introduced by the `install` method.
+* the `install` method is called when the user enables the extension in the configuration page. It must return _true_ when successful and a string containing an error message when not. Its purpose is to prepare FreshRSS for the extension (adding a table to the database, creating a folder tree, …).
+* the `uninstall` method is called when the user disables the extension in the configuration page. It must return _true_ when successful and a string containing an error message when not. Its purpose is to clean FreshRSS (removing a table from the database, deleting a folder tree, …). Usually it reverts changes introduced by the `install` method.
* the `handleConfigureAction` method is called when a user loads the extension configuration panel. It contains the logic to validate and store the submitted values defined in the `configure.phtml` file.
-> If your extension code is scattered in different classes, you need to load their source before using them. Of course you could include the files manually, but it's more efficient to load them automatically. To do so, you just need to define the `autoload` method which will include them when needed. This method will be registered automatically when the extension is enabled.
+> If your extension code is scattered in different classes, you need to load their source before using them. Of course you could include the files manually, but it’s more efficient to load them automatically. To do so, you just need to define the `autoload` method which will include them when needed. This method will be registered automatically when the extension is enabled.
The `Minz_Extension` abstract class defines another set of methods that should not be overridden:
* the `getName`, `getEntrypoint`, `getPath`, `getAuthor`, `getDescription`, `getVersion`, and `getType` methods return the extension internal properties. Those properties are extracted from the `metadata.json` file.
@@ -311,7 +311,7 @@ The `Minz_Extension` abstract class defines another set of methods that should n
* the `setUserConfiguration` method stores the extension configuration for the current user.
* the `removeUserConfiguration` method removes the extension configuration for the current user.
-> Note that if you modify the later set of methods, you might break the extension system. Thus making FreshRSS unusable. So it's highly recommended to let those unmodified.
+> Note that if you modify the later set of methods, you might break the extension system. Thus making FreshRSS unusable. So it’s highly recommended to let those unmodified.
### The "hooks" system
@@ -332,7 +332,7 @@ class HelloWorldExtension extends Minz_Extension
The following events are available:
-* `check_url_before_add` (`function($url) -> Url | null`): will be executed every time a URL is added. The URL itself will be passed as parameter. This way a website known to have feeds which doesn't advertise it in the header can still be automatically supported.
+* `check_url_before_add` (`function($url) -> Url | null`): will be executed every time a URL is added. The URL itself will be passed as parameter. This way a website known to have feeds which doesn’t advertise it in the header can still be automatically supported.
* `entry_before_display` (`function($entry) -> Entry | null`): will be executed every time an entry is rendered. The entry itself (instance of FreshRSS\_Entry) will be passed as parameter.
* `entry_before_insert` (`function($entry) -> Entry | null`): will be executed when a feed is refreshed and new entries will be imported into the database. The new entry (instance of FreshRSS\_Entry) will be passed as parameter.
* `feed_before_actualize` (`function($feed) -> Feed | null`): will be executed when a feed is updated. The feed (instance of FreshRSS\_Feed) will be passed as parameter.
diff --git a/docs/en/developers/03_Running_tests.md b/docs/en/developers/03_Running_tests.md
index b20f38985..197a01057 100644
--- a/docs/en/developers/03_Running_tests.md
+++ b/docs/en/developers/03_Running_tests.md
@@ -12,7 +12,7 @@ make test
This command downloads the PHPUnit binary and verifies its checksum. If the verification fails, the file is deleted. In this case, you should [open an issue on GitHub](https://github.com/FreshRSS/FreshRSS/issues/new) to let maintainers know about the problem.
-Then, it executes PHPUnit in a Docker container. If you don't use Docker, you can run the command directly with:
+Then, it executes PHPUnit in a Docker container. If you don’t use Docker, you can run the command directly with:
```sh
NO_DOCKER=true make test
diff --git a/docs/en/developers/04_Frontend/02_Design.md b/docs/en/developers/04_Frontend/02_Design.md
index 4ec8253ad..f3dbc10eb 100644
--- a/docs/en/developers/04_Frontend/02_Design.md
+++ b/docs/en/developers/04_Frontend/02_Design.md
@@ -7,7 +7,7 @@
The easiest way to create a theme is by copying and modifying the base theme (or another of the pre-installed themes). The base theme can be found in [/p/themes/base-theme](https://github.com/FreshRSS/FreshRSS/tree/edge/p/themes/base-theme). Themes require:
- a **metadata.json** file to describe the theme.
-- a **loader.gif** file to use as a loading icon (assuming .loading's background has not been overridden)
+- a **loader.gif** file to use as a loading icon (assuming .loading’s background has not been overridden)
- an **icons** folder containing .svg, .ico, and .png files to override existing icons
- a **thumbs** folder containing a file, **original.png** that will be used as the preview for the theme
@@ -19,7 +19,7 @@ RTL (right-to-left) support for languages such as Hebrew and Arabic is handled t
## Overriding icons
-To replace the default icons, add an "icons" folder to your theme's folder. Use files with the same name as the default icon to override them.
+To replace the default icons, add an "icons" folder to your theme’s folder. Use files with the same name as the default icon to override them.
## Template file
diff --git a/docs/en/developers/04_Pull_requests.md b/docs/en/developers/04_Pull_requests.md
index 6f5bab655..1169a10b1 100644
--- a/docs/en/developers/04_Pull_requests.md
+++ b/docs/en/developers/04_Pull_requests.md
@@ -1,8 +1,8 @@
# Opening a pull request
-So you want to propose a patch to the community? It's time to open a [pull request](https://github.com/FreshRSS/FreshRSS/pulls)!
+So you want to propose a patch to the community? It’s time to open a [pull request](https://github.com/FreshRSS/FreshRSS/pulls)!
-When you open a PR, your message will be prefilled with a message based on [a template](https://github.com/FreshRSS/FreshRSS/blob/edge/docs/pull_request_template.md). It contains a checklist to make sure you didn't forget anything. It is very important to verify you did everything mentioned so documentation is up-to-date, the commit history stays clear and the code is always stable.
+When you open a PR, your message will be prefilled with a message based on [a template](https://github.com/FreshRSS/FreshRSS/blob/edge/docs/pull_request_template.md). It contains a checklist to make sure you didn’t forget anything. It is very important to verify you did everything mentioned so documentation is up-to-date, the commit history stays clear and the code is always stable.
The rest of this document explains specific points.
@@ -12,11 +12,11 @@ The rest of this document explains specific points.
Rebasing a branch is useful to make sure your code is based on the most recent version of FreshRSS and there are no conflicts. You have two ways to do that.
-If you have any doubt, please let us know and we'll help you! We all began with Git one day and it's not an easy thing to work with.
+If you have any doubt, please let us know and we’ll help you! We all began with Git one day and it’s not an easy thing to work with.
### Rebasing
-Rebasing is the cleanest method because the Git history will be completely linear and consequently easier to read and navigate. It might also be more difficult if you're not at ease with Git since conflicts are harder to resolve.
+Rebasing is the cleanest method because the Git history will be completely linear and consequently easier to read and navigate. It might also be more difficult if you’re not at ease with Git since conflicts are harder to resolve.
Note that you should never rebase a branch if someone else is working on it. Otherwise, since it rewrites the history, it can be a real mess to sort it out.
@@ -33,7 +33,7 @@ If you feel confident, you can use `git rebase -i edge` to rewrite your history
### Merging
-If you prefer, you can simply merge `edge` into your own branch. Conflicts might be easier to resolve, but your Git history will be less readable. Don't worry, we'll take care of it before merging your PR back into `edge`.
+If you prefer, you can simply merge `edge` into your own branch. Conflicts might be easier to resolve, but your Git history will be less readable. Don’t worry, we will take care of it before merging your PR back into `edge`.
To merge `edge`:
@@ -46,13 +46,13 @@ git merge edge # merge edge into your branch
## How to write a Git commit message
-It's important to have proper commit messages in order to facilitate later debugging, so please read the following advice. Commit messages should explain the choices made in the past (the “why?”)
+It’s important to have proper commit messages in order to facilitate later debugging, so please read the following advice. Commit messages should explain the choices made in the past (the “why?”)
-The first line should start with a verb (e.g., "Add") and explain the objective of the commit in few words. It's usually less than 50 characters so it remains concise. You can consider this line the subject of your commit. Think of it as the second part of a sentence that starts with the words "This commit will."
+The first line should start with a verb (e.g., “Add”) and explain the objective of the commit in few words. It’s usually less than 50 characters so it remains concise. You can consider this line the subject of your commit. Think of it as the second part of a sentence that starts with the words “This commit will.”
* This commit will *add feature X*
-Then, insert a blank line, and start to write the body. It's usually wrapped at 72 characters, but you are pretty free in the tone of the message. The body is the place where you can clarify the context of your patch. For instance, you can explain what you were doing when you identified a bug, or the problem you had before your patch. Providing this information helps other developers understand why a specific choice was made, especially when a patch introduces a bug that is identified months later.
+Then, insert a blank line, and start to write the body. It’s usually wrapped at 72 characters, but you are pretty free in the tone of the message. The body is the place where you can clarify the context of your patch. For instance, you can explain what you were doing when you identified a bug, or the problem you had before your patch. Providing this information helps other developers understand why a specific choice was made, especially when a patch introduces a bug that is identified months later.
You also can add references (e.g., the URL to the initial ticket in the bug tracker, or a reference to some forum explaining a point).
@@ -60,16 +60,16 @@ You can find more information about commit messages [on this blog post](https://
## How to write tests
-FreshRSS has few tests for now, but we're working on it. We added this point to the checklist to help us to write more tests, and we would really appreciate it if you wrote a test that ensures your patch is working.
+FreshRSS has few tests for now, but we’re working on it. We added this point to the checklist to help us to write more tests, and we would really appreciate it if you wrote a test that ensures your patch is working.
We use [PHPUnit](https://phpunit.de/) version 7.5 ([documentation](https://phpunit.readthedocs.io/en/7.5/)).
-You'll find more information on how to run tests [in this document](03_Running_tests.md).
+You’ll find more information on how to run tests [in this document](03_Running_tests.md).
-Feel free to ask us for assistance. Not everything will be easy to test, so don't spend too much time on this.
+Feel free to ask us for assistance. Not everything will be easy to test, so don’t spend too much time on this.
## Why you should write documentation
-A friendly project should have correct and complete documentation, so newcomers don't have to ask too many questions, and users can find answers to their problems. The documentation should not be written “later” or chances are it'll never be.
+A friendly project should have correct and complete documentation, so newcomers don’t have to ask too many questions, and users can find answers to their problems. The documentation should not be written “later” or chances are it’ll never be.
-Our documentation can still be improved quite a bit, so you're very welcome if you want to help.
+Our documentation can still be improved quite a bit, so you’re very welcome if you want to help.
diff --git a/docs/en/developers/05_Release_new_version.md b/docs/en/developers/05_Release_new_version.md
index 918451490..46bec973c 100644
--- a/docs/en/developers/05_Release_new_version.md
+++ b/docs/en/developers/05_Release_new_version.md
@@ -1,9 +1,9 @@
# Preparing the release
-In order to get as much feedback as possible before a release, it's preferable to announce it on GitHub by creating a dedicated ticket
+In order to get as much feedback as possible before a release, it’s preferable to announce it on GitHub by creating a dedicated ticket
([see examples](https://github.com/FreshRSS/FreshRSS/search?utf8=%E2%9C%93&q=Call+for+testing&type=Issues)). This should be done **at least one week in advance**.
-It's also recommended to make the announcement on mailing@freshrss.org.
+It’s also recommended to make the announcement on mailing@freshrss.org.
## Check the dev status
@@ -27,7 +27,7 @@ $ git push && git push --tags
## Updating `update.freshrss.org`
-It's important to update update.freshrss.org since this is the default service for automatic FreshRSS updates.
+It’s important to update update.freshrss.org since this is the default service for automatic FreshRSS updates.
The repository managing the code is located on GitHub: [FreshRSS/update.freshrss.org](https://github.com/FreshRSS/update.freshrss.org/).
@@ -35,7 +35,7 @@ The repository managing the code is located on GitHub: [FreshRSS/update.freshrss
The scripts are located in the `./scripts/` directory and must take the form `update_to_x.y.z.z.php`. This directory also contains `update_to_dev.php` intended for updates of the `edge` branch (this script must not include code specific to a particular version!) and `update_util.php`, which contains a list of functions useful for all scripts.
-In order to write a new script, it's better to copy/paste the last version or to start from `update_to_dev.php`. The first thing to do is to define the URL from which the FreshRSS package will be downloaded (`PACKAGE_URL`). The URL is in the form of `https://codeload.github.com/FreshRSS/FreshRSS/zip/x.y.z`.
+In order to write a new script, it’s better to copy/paste the last version or to start from `update_to_dev.php`. The first thing to do is to define the URL from which the FreshRSS package will be downloaded (`PACKAGE_URL`). The URL is in the form of `https://codeload.github.com/FreshRSS/FreshRSS/zip/x.y.z`.
There are then 5 functions that have to be executed:
@@ -47,9 +47,9 @@ There are then 5 functions that have to be executed:
## Updating the versions file
-Once the script has been written and versioned, it's necessary to update the `./versions.php' file which contains a mapping table indicating which versions are updated to which other versions.
+Once the script has been written and versioned, it’s necessary to update the `./versions.php' file which contains a mapping table indicating which versions are updated to which other versions.
-Here's an example of a `versions.php` file:
+Here’s an example of a `versions.php` file:
```php
<?php
@@ -57,7 +57,7 @@ return array(
// STABLE
'0.8.0' => '1.0.0',
'0.8.1' => '1.0.0',
- '1.0.0' => '1.0.1', // doesn't exist (yet)
+ '1.0.0' => '1.0.1', // doesn’t exist (yet)
// DEV
'1.1.2-dev' => 'dev',
'1.1.3-dev' => 'dev',
@@ -65,21 +65,21 @@ return array(
);
```
-And here's how this table works:
+And here’s how this table works:
* on the left you can find the N version, on the right the N+1 version;
* the `x.y.z.z-dev` versions are **all** updated to `edge`;
* stable versions are updated to stable versions;
-* it's possible to skip several versions at once, provided that the update scripts support it;
-* it's advisable to indicate the correspondence of the current version to its potential future version by specifying that this version does not yet exist. As long as the corresponding script does not exist, nothing will happen.
+* it’s possible to skip several versions at once, provided that the update scripts support it;
+* it’s advisable to indicate the correspondence of the current version to its potential future version by specifying that this version does not yet exist. As long as the corresponding script does not exist, nothing will happen.
-It's **very strongly** recommended to keep this file organized according to version numbers by separating stable and dev versions.
+It’s**very strongly** recommended to keep this file organized according to version numbers by separating stable and dev versions.
## Deployment
-Before updating update.freshrss.org, it's better to test with dev.update.freshrss.org, which corresponds to pre-production. So update dev.update.freshrss.org and change the `FRESHRSS_UPDATE_WEBSITE` URL of your FreshRSS instance. Start the update and check that it's running correctly.
+Before updating update.freshrss.org, it’s better to test with dev.update.freshrss.org, which corresponds to pre-production. So update dev.update.freshrss.org and change the `FRESHRSS_UPDATE_WEBSITE` URL of your FreshRSS instance. Start the update and check that it’s running correctly.
-When you're satisfied, update update.freshrss.org with the new script, test it again, and then move on.
+When you’re satisfied, update update.freshrss.org with the new script, test it again, and then move on.
## Updating the FreshRSS services
@@ -90,7 +90,7 @@ Two services need to be updated immediately after the update.
## Publicly announce the release
-When everything's working, it's time to announce the release to the world!
+When everything’s working, it’s time to announce the release to the world!
* on GitHub by creating[a new release](https://github.com/FreshRSS/FreshRSS/releases/new)
* on the freshrss.org blog, at least for stable versions (write the article on[FreshRSS/freshrss.org](https://github.com/FreshRSS/freshrss.org))
diff --git a/docs/en/developers/06_Fever_API.md b/docs/en/developers/06_Fever_API.md
index 909fd6074..287885089 100644
--- a/docs/en/developers/06_Fever_API.md
+++ b/docs/en/developers/06_Fever_API.md
@@ -7,7 +7,7 @@ Additionally [page about our Google Reader compatible API](06_GoogleReader_API.m
## RSS clients
There are many RSS clients that support the Fever API, but they seem to understand the Fever API a bit differently.
-If your favourite client doesn't work properly with this API, please create an issue and we'll have a look.
+If your favourite client doesn’t work properly with this API, please create an issue and we’ll have a look.
But we can **only** do that for free clients.
### Usage & Authentication
@@ -80,7 +80,7 @@ This should give:
"last_refreshed_on_time": "1520013061"
}
```
-Perfect, you're now authenticated and you can start testing the more advanced features. To do so, change the URL and append the possible API actions to your request parameters. Please refer to the [original Fever documentation](https://feedafever.com/api) for more information.
+Perfect, you’re now authenticated and you can start testing the more advanced features. To do so, change the URL and append the possible API actions to your request parameters. Please refer to the [original Fever documentation](https://feedafever.com/api) for more information.
Some basic calls are:
diff --git a/docs/en/developers/06_GoogleReader_API.md b/docs/en/developers/06_GoogleReader_API.md
index 5035ca6cf..970ce824f 100644
--- a/docs/en/developers/06_GoogleReader_API.md
+++ b/docs/en/developers/06_GoogleReader_API.md
@@ -6,7 +6,7 @@ Additionally [page about our Fever compatible API](06_Fever_API.md) for another
## RSS clients
There are many RSS clients that support the Fever API, but they might understand the API a bit differently.
-If your favourite client doesn't work properly with this API, please create an issue and we'll have a look.
+If your favourite client doesn’t work properly with this API, please create an issue and we’ll have a look.
But we can **only** do that for free clients.
## Usage & Authentication
diff --git a/docs/en/developers/06_Reporting_Bugs.md b/docs/en/developers/06_Reporting_Bugs.md
index 77b16251f..4f53c0ee4 100644
--- a/docs/en/developers/06_Reporting_Bugs.md
+++ b/docs/en/developers/06_Reporting_Bugs.md
@@ -1,17 +1,17 @@
# Reporting a bug or a suggestion
-Despite the care given to FreshRSS, it's still possible that bugs occur. Development is dynamic, so issues can be corrected quickly. You might also have a feature in mind that doesn't yet exist. Regardless whether your idea seems silly, far-fetched, useless or too specific, please don't hesitate to propose it to us! "Ideas in the air" often find an attentive ear. It's new external perspectives that make the project evolve the most.
+Despite the care given to FreshRSS, it’s still possible that bugs occur. Development is dynamic, so issues can be corrected quickly. You might also have a feature in mind that doesn’t yet exist. Regardless whether your idea seems silly, far-fetched, useless or too specific, please don’t hesitate to propose it to us! “Ideas in the air” often find an attentive ear. It’s new external perspectives that make the project evolve the most.
-If you're convinced that you should be heard, here's how you can go about it.
+If you’re convinced that you should be heard, here’s how you can go about it.
## On GitHub
-GitHub is the ideal platform to submit your requests. It allows us to discuss a problem or suggestion with others and it often generates new ideas. Let's not neglect this "social" aspect!
+GitHub is the ideal platform to submit your requests. It allows us to discuss a problem or suggestion with others and it often generates new ideas. Let’s not neglect this “social” aspect!
1. [Go to the bug ticket manager](https://github.com/FreshRSS/FreshRSS/issues)
-2. Start by checking if a similar request hasn't already been made. If so, please feel free to add your voice to the request.
+2. Start by checking if a similar request hasn’t already been made. If so, please feel free to add your voice to the request.
3. If your request is new, [open a new bug ticket](https://github.com/FreshRSS/FreshRSS/issues/new)
-4. Finally, write your request. If you're fluent in English, it's the preferred language because it allows for discussion with the largest number of people.
+4. Finally, write your request. If you’re fluent in English, it’s the preferred language because it allows for discussion with the largest number of people.
5. Please follow the tips below to make it easier to let your ticket be heard.
## Informal
@@ -29,17 +29,17 @@ Not everyone likes or uses GitHub for a variety of legitimate reasons. That is w
Here are some tips to help you present your bug report or suggestion:
-* **Pay attention to spelling**. Even if it's not always easy, try your best!
-* **Give an explicit title to your request**, even if it's a bit long. This not only helps us understand your request, but also to find your ticket later.
-* **One request = one ticket.** You may have lots of ideas while being afraid to spam the bug manager: it doesn't matter. It's better to have a few too many tickets than too many requests in one. We'll close and consolidate requests when possible.
+* **Pay attention to spelling**. Even if it’s not always easy, try your best!
+* **Give an explicit title to your request**, even if it’s a bit long. This not only helps us understand your request, but also to find your ticket later.
+* **One request = one ticket.** You may have lots of ideas while being afraid to spam the bug manager: it doesn’t matter. It’s better to have a few too many tickets than too many requests in one. We’ll close and consolidate requests when possible.
* If you report a bug, think about **providing us with the FreshRSS logs** (accessible in the FreshRSS `data/log/` folder) and the **PHP logs** (the location may vary by distribution, but consider searching in `/var/log/httpd` or `/var/log/apache`).
-* If you can't find the log files, specify it in your ticket so we know you've already searched.
+* If you can’t find the log files, specify it in your ticket so we know you’ve already searched.
* Not all bugs require logs, but if you have any doubts, it is better to provide them to us. Logs are important and very useful for debugging!
* The logs may reveal confidential information, so **be careful not to disclose anything sensitive.**
-In addition, when facing a bug, you're encouraged to follow this message format (from the [Sam & Max website](http://sametmax.com/template-de-demande-daide-en-informatique/):
+In addition, when facing a bug, you’re encouraged to follow this message format (from the [Sam & Max website](http://sametmax.com/template-de-demande-daide-en-informatique/):
-### What's my goal?
+### What’s my goal?
Give the general context of what you were trying to do.
@@ -49,7 +49,7 @@ Explain step by step what you have done so that we can reproduce the bug.
### What results have I achieved?
-The bug: what you see that shouldn't have happened. Here you can provide the logs.
+The bug: what you see that shouldn’t have happened. Here you can provide the logs.
### What was the expected result?
@@ -63,4 +63,4 @@ Remember to give the following information if you know it:
2. Which server: Apache, Nginx? Which version?
3. Which version of PHP?
4. Which database: SQLite, MySQL, MariaDB, PostgreSQL? Which version?
-5. Which distribution runs on the server? And... which version?
+5. Which distribution runs on the server? And… which version?