diff options
| author | 2017-12-22 12:02:06 +0100 | |
|---|---|---|
| committer | 2017-12-22 12:02:06 +0100 | |
| commit | 469d601bcbe83eb800552ca6327dac7732763c75 (patch) | |
| tree | 61f3e0d6654f30bd4e394ba29fe1ecdd770ea1dd /docs | |
| parent | caccf8a970afa237cc44b49042c1a80b2158b2f6 (diff) | |
[doc] Editing for better style (#1736)
* Also removed references to Persona authentication.
* Changed code comment about Persona because it's for HTTP auth
in general. See https://github.com/FreshRSS/FreshRSS/commit/3d876091e1268e3ccd5036449a4deb5134936206
and https://github.com/FreshRSS/FreshRSS/issues/358#issuecomment-31931484
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/en/index.md | 12 | ||||
| -rw-r--r-- | docs/en/users/03_Main_view.md | 16 | ||||
| -rw-r--r-- | docs/en/users/07_Frequently_Asked_Questions.md | 10 | ||||
| -rw-r--r-- | docs/fr/users/03_Main_view.md | 2 | ||||
| -rw-r--r-- | docs/fr/users/07_Frequently_Asked_Questions.md | 2 | ||||
| -rw-r--r-- | docs/index.md | 4 |
6 files changed, 23 insertions, 23 deletions
diff --git a/docs/en/index.md b/docs/en/index.md index a0c97a0d9..59cbdc296 100644 --- a/docs/en/index.md +++ b/docs/en/index.md @@ -1,19 +1,19 @@  -FreshRSS is a RSS aggregator and reader. It gives you possibility to read and follow several news website at a glance without the need to go from a website to another. +FreshRSS is an RSS aggregator and reader. It allows you to read and follow several news websites at a glance without the need to browse from one website to another. FreshRSS has a lot of features including: - RSS and Atom aggregation - Mark article as favorite if you liked it or if you want to read it later -- Filter and search functionalities are working together to find easily articles -- Statistics help you to know the frequency of publishing of all the websites you are following +- Filter and search functionality helps to easily find articles +- Statistics to show you the publishing frequency all the websites you follow - Import/export of your feeds into OPML format - Several themes created by the community - "Google Reader"-like API to connect Android applications -- The application is "responsive" which means it adapts to small screens so you can bring articles in your pocket -- Self-hosted: code is free (under AGPL3 licence) and so you can host your own instance of FreshRSS -- Multi-users so you can host your friends and your family +- The application is "responsive," which means it adapts to small screens so you can bring articles in your pocket +- Self-hosted: the code is free (under AGPL3 licence), so you can host your own instance of FreshRSS +- Multi-user, so you can also host for your friends and family - And a lot more! This documentation is split into four sections: diff --git a/docs/en/users/03_Main_view.md b/docs/en/users/03_Main_view.md index 53b0beaf2..adb62c7ec 100644 --- a/docs/en/users/03_Main_view.md +++ b/docs/en/users/03_Main_view.md @@ -45,9 +45,9 @@ This is the most straightforward since you have a public instance; there is noth 0 * * * * curl 'https://your.server.net/FreshRSS/p/i/?c=feed&a=actualize' ``` -### Form or Persona authentication +### Form authentication -In those cases, if you configure the application to allow anonymous reading, you can also allow anonymous user to update feeds (“Allow anonymous refresh of the articles”). +If you configure the application to allow anonymous reading, you can also allow anonymous users to update feeds (“Allow anonymous refresh of the articles”).  @@ -96,14 +96,14 @@ This update occurs on the selected feed only. To trigger it, you need to click o While the number of articles stored by FreshRSS increase, it is important to have efficient filters to display only a subset of the articles. There is several methods with different criterion. Most of the time, those methods can be combined. -##By category +## By category -It is the easiest method. The only thing to do is clicking on the category title in the side panel. There is two special categories on top of that panel: +This is the easiest method. You only need to click on the category title in the side panel. There are two special categories on top of that panel: * *Main feed* which displays only articles from feeds marked as available in that category * *Favourites* which displays only articles marked as favourites -##By feed +## By feed There is several methods to filter articles by feed: @@ -114,7 +114,7 @@ There is several methods to filter articles by feed:  -##By status +## By status Each article has two attributes, which can be combined. The first attribute indicates if the article was read or not. The second attribute indicates if the article was marked as favorite or not. @@ -128,11 +128,11 @@ Starting with version 0.8, all attribute filters are visible as toggle icons. Th By default, this filter displays only unread articles -##By content +## By content It is possible to filter articles by their content by inputting a string in the search field. -##With the search field +## With the search field It is possible to use the search field to further refine results: diff --git a/docs/en/users/07_Frequently_Asked_Questions.md b/docs/en/users/07_Frequently_Asked_Questions.md index 6391c55f5..427da7bd9 100644 --- a/docs/en/users/07_Frequently_Asked_Questions.md +++ b/docs/en/users/07_Frequently_Asked_Questions.md @@ -4,10 +4,10 @@ We may not have answered all of your questions in the previous sections. The FAQ Of course, ```/i``` has a purpose! We used it for performance and usability: -* it allows to serve icons, images, styles and scripts without cookies. Whitout that trick, those files will be downloaded more often, specially when the form or the Personna authentications are used. Also, HTTP requests will be heavier. +* It allows for serving icons, images, styles and scripts without cookies. Without that trick, those files would be downloaded more often, especially when form authentication is used. Also, HTTP requests would be heavier. * ```./p/``` public root can be served without any HTTP access restrictions. Whereas it could be implemented in ```./p/i/```. -* It spares from having problems while serving public resources like ```favicon.ico```, ```robots.txt```, etc. -* It allows to display the logo instead of a white page while hitting a restriction or a delay during the loading process. +* It avoids problems while serving public resources like ```favicon.ico```, ```robots.txt```, etc. +* It allows the logo to be displayed instead of a white page while hitting a restriction or a delay during the loading process. ## Why robots.txt is located in a sub-folder? @@ -28,8 +28,8 @@ Here are the steps to follow: 1. __Verify SimplePie validation__ with the [SimplePie on-line tool](http://simplepie.org/demo/ "SimplePie official demo"). If it is not recognized, there is nothing we can do. 1. __Verify FreshRSS integration__ with the [demo](http://demo.freshrss.org "FreshRSS official demo"). If it is not working, you need to [create an issue on Github](https://github.com/FreshRSS/FreshRSS/issues/new "Create an issue for FreshRSS") so we can have a look at it. If it is working, there is probably something fishy with the hosting server. -Here is a list of feed which don't work: +Here is a list of feeds which don't work: * http://foulab.org/fr/rss/Foulab_News: is not a W3C valid feed (November 2014) * http://eu.battle.net/hearthstone/fr/feed/news: is not a W3C valid feed (Novembre 2014) -* http://webseriesmag.blogs.liberation.fr/we/atom.xml: is not working for the user but succeed on all the described validations (November 2014)
\ No newline at end of file +* http://webseriesmag.blogs.liberation.fr/we/atom.xml: is not working for the user but succeed on all the described validations (November 2014) diff --git a/docs/fr/users/03_Main_view.md b/docs/fr/users/03_Main_view.md index 744141b7d..ebf782136 100644 --- a/docs/fr/users/03_Main_view.md +++ b/docs/fr/users/03_Main_view.md @@ -45,7 +45,7 @@ C’est le cas le plus simple, puisque votre instance est publique, vous n’ave 0 * * * * curl 'https://votre.serveur.net/FreshRSS/p/i/?c=feed&a=actualize' ``` -##### Authentification par formulaire ou Persona +##### Authentification par formulaire Dans ces cas-là, si vous avez autorisé la lecture anonyme des articles, vous pouvez aussi permettre à n’importe qui de rafraîchir vos flux (« Autoriser le rafraîchissement anonyme des flux »). diff --git a/docs/fr/users/07_Frequently_Asked_Questions.md b/docs/fr/users/07_Frequently_Asked_Questions.md index 9dc80b2e4..1f4d059ce 100644 --- a/docs/fr/users/07_Frequently_Asked_Questions.md +++ b/docs/fr/users/07_Frequently_Asked_Questions.md @@ -4,7 +4,7 @@ Il est possible que nous n'ayons pas répondu à toutes vos questions dans les p Bien entendu, le ```/i``` n'est pas là pour faire joli ! Il s'agit d'une question de performances et de praticité : -* Cela permet de servir les icônes, images, styles, scripts sans cookie. Sans cela, ces fichiers seraient souvent re-téléchargés, en particulier lorsque Persona ou le formulaire de connexion sont utilisés. De plus, les requêtes vers ces ressources seraient plus lourdes. +* Cela permet de servir les icônes, images, styles, scripts sans cookie. Sans cela, ces fichiers seraient souvent re-téléchargés, en particulier lorsque le formulaire de connexion est utilisé. De plus, les requêtes vers ces ressources seraient plus lourdes. * La racine publique ```./p/``` peut être servie sans restriction d'accès HTTP (qui peut avantageusement être mise en place dans ```./p/i/```). * Cela permet d'éviter des problèmes pour des fichiers qui doivent être publics pour bien fonctionner, comme ```favicon.ico```, ```robots.txt```, etc. * Cela permet aussi d'avoir un logo FreshRSS plutôt qu'une page blanche pour accueillir l'utilisateur par exemple dans le cas de la restriction d'accès HTTP ou lors de l'attente du chargement plus lourd du reste de l'interface. diff --git a/docs/index.md b/docs/index.md index 9afdcec38..86a660d16 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ -# Welcome on FreshRSS documentation center! +# Welcome to the FreshRSS documentation! -This documentation is under construction. If you want to contribute, [find us on GitHub](https://github.com/FreshRSS/FreshRSS). +This documentation is still under construction. If you want to contribute, you can [find us on GitHub](https://github.com/FreshRSS/FreshRSS). - [English documentation](./en/index.md) - [Documentation française](./fr/index.md) |
