aboutsummaryrefslogtreecommitdiff
path: root/docs/en
AgeCommit message (Collapse)Author
2022-01-21Fixup #3991 (#3992)Gravatar xnaas
* fixup #3991 * add xnaas to CREDITS.md * Update docs/en/users/03_Main_view.md Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * fix typo * Update docs/en/users/03_Main_view.md The lines were combined into one line and `'` was replaced with `’` for contracted words. Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr> Co-authored-by: maTh <math-home@web.de> Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2022-01-08Use typographic quotes (#4133)Gravatar Alexandre Alapetite
* 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
2022-01-08Fix various typos and spelling errors in documentation, comments and code. ↵Gravatar Thomas Renes
(#4134)
2022-01-08Change i18n process (#4131)Gravatar Alexis Degrugillier
Before, the ignore info were stored in a different file which was a bit cumbersome for new comers. Now, this info is stored directly in the translation file as a comment. Before, there was no way of telling translators that a previously translated string was in need of a new translation. Now, the dirty information is there to convey that info.
2022-01-04PHPStan level 5 (#4110)Gravatar Alexandre Alapetite
* Fix most PHPDocs errors Contributes to https://github.com/FreshRSS/FreshRSS/issues/4103 https://phpstan.org/writing-php-code/phpdoc-types * Avoid func_get_args Use variadic syntax instead https://php.net/manual/functions.arguments#functions.variable-arg-list And avoid dynamic functions names when possible to more easily identify calls and unused functions. Contributes to https://github.com/FreshRSS/FreshRSS/issues/4103 * PHPStan level 3 * PHPStand level 4 * Update default to PHPStan level 4 * Towards level 5 * Fix level 4 regression * Towards level 5 * Pass PHPStan level 5 * Towards level 6 * Remove erronenous regression from changelog https://github.com/FreshRSS/FreshRSS/pull/4116
2021-12-31Search on article IDs (#4058)Gravatar Alexandre Alapetite
* Search on article IDs Partial implementation of https://github.com/FreshRSS/FreshRSS/issues/4053
2021-12-26Improved manual: User Management/User registration (#4083)Gravatar maTh
* Draft 1 of Default User page * Draft1 of User Management page * Update 01_Index.md * Update 12_User_management.md * fix failing pipeline * Apply suggestions from code review Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
2021-12-23Correct cron example (#4079)Gravatar 4xfu
The old example was inaccurate. crontab on Debian does not support a user name, but files in /etc/cron.d and /etc/crontab do (see https://manpages.debian.org/bullseye/cron/crontab.5.en.html) According to https://manpages.debian.org/bullseye/cron/cron.8.en.html : In general, the system administrator should not use /etc/cron.d/, but use the standard system crontab /etc/crontab so I propose to append the line to this file
2021-12-20Improved: Manual: username+pw for demo login (#4072)Gravatar maTh
* added: username+pw for demo login * fix white spaces
2021-12-10Update 02_First_steps.md (#4049)Gravatar happymacarts
spelling correction of "available"
2021-11-24Fix typo of 'envelope' and reference De Morgan's laws (#3991)Gravatar xnaas
2021-11-02Remove remains of Travis (#3941)Gravatar Alexandre Alapetite
* Remove remains of Travis Follow-up of https://github.com/FreshRSS/FreshRSS/pull/3920 * Update docs/en/developers/03_Running_tests.md Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * Apply suggestions from code review Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> Co-authored-by: Alexis Degrugillier <aledeg@users.noreply.github.com>
2021-10-25Add a reminder for NGINX installations (#3741) (#3934)Gravatar Kaibin Yang
Update docs/en/admins/03_Installation.md
2021-10-24Hot fix broken links documentationGravatar Alexandre Alapetite
Bug from https://github.com/FreshRSS/FreshRSS/pull/3905
2021-10-23Improved markdownlint (#3918)Gravatar Alexandre Alapetite
* Improved markdownlint * Relaxed rules slighlty * `npm run markdownlint` for automatic tests * `npm run markdownlint_fix` for automatic syntax fixing * Applied the fixes on all our Markdown files
2021-10-23Split fever & greader into two separate pages. (#3905)Gravatar Felix Bühler
* [docs] add newsflash to fever-clients * [docs] split fever&greader-apis into two pages and make the more consistent
2021-10-23Update Korean Translation with language code fix (#3914)Gravatar OctopusET
* Update Korean Translation * Fix Korean language code following IETF BCP 47 * Fix Korean language code in i18n/*/gen.php * Fix Korean language code in cli/i18n/* * Fix Korean language code in docs Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2021-08-30Fix documentation typo (#3810)Gravatar Alexis Degrugillier
See #3809
2021-08-20docs (#3784)Gravatar maTh
2021-08-14Fix docs link to dev themes (#3746)Gravatar maTh
* link fixed * fix2
2021-07-24Search labels (#3709)Gravatar Alexandre Alapetite
* Search labels #fix https://github.com/FreshRSS/FreshRSS/issues/3704 * Documentation * Allow list without quotes * Allow boolean AND searches * Allow searching any label * fix labels alias
2021-07-11Add system configuration for extension (#3626)Gravatar Alexis Degrugillier
Before, only the user configuration was supported by extensions. But it was limiting if one has to create a system extension with configuration. Now, both user and system configuration are supported.
2021-06-29[docs] Fix typo in server requirements (#3681)Gravatar Frans de Jonge
2021-06-07Drop PHP5 and IE11 (#3666)Gravatar Alexandre Alapetite
* Drop PHP5 and IE11 https://github.com/FreshRSS/FreshRSS/discussions/3321 Our Docker :oldest is now based on Alpine 3.5 (2016-12-22) * More uniform * More changelog
2021-06-06Update 08_FeedUpdates.md (#3635)Gravatar marcohald
* Update 08_FeedUpdates.md Added hint to https://freshrss.github.io/FreshRSS/en/users/03_Main_view.html#online-cron * Update docs/en/admins/08_FeedUpdates.md * Update docs/en/admins/08_FeedUpdates.md Co-authored-by: marcohald <marcohald@users.noreply.github.com> Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2021-05-04Update README.md (#3601)Gravatar Strubbl
* Update README.md Readably is not available anymore * More lines to remove Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2021-04-08Newsboat support (#3574)Gravatar Petra Lamborn
* Newsboat support Newsboat is a feed reader for the unix-derived terminal, and is the successor to Newsbeuter. FreshRSS support has been merged into master <https://github.com/newsboat/newsboat/commit/f18145fc98700178429cbd137e0309f89ec89d5b> but there has not yet been a release since then. In the meantime I've created this pull request that can be merged whenever it becomes strictly accurate. I've filled out the table to the best of my ability, but I'm not completely clear on what "Fast sync" and "Fetch more in individual views" mean. * Does not work offline with freshrss * More doc Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2021-03-26tec: Remove data/do-install.txt (#3555)Gravatar berumuron
* Remove file data/do-install.txt This file was painful during update because we had to remember to delete it each time. It added a security issue by allowing an attacker to reinstall FreshRSS during the update process. The (more powerful) file data/applied_migrations.txt has been introduced in 8619cf6fa to replace do-install.txt. We had to wait for at least one release in order to make sure existing instances of FreshRSS created the migration file. It should be ok now. * Replace i18n install.not_deleted key * Update documentation to update FreshRSS
2021-03-15Quick update the doc for master renaming to edgeGravatar Alexandre Alapetite
2021-03-10FocusReader (#3514)Gravatar Alexandre Alapetite
2021-02-17Add user maintenance hooks (#3440)Gravatar Alexis Degrugillier
The new hook allows to add maintenance extensions at the user level. See #3398
2021-02-06Theme Documentation (#3415)Gravatar Lukas Vacula
* adding self CREDITS.md * add "theme" to link for easier navigation * add documentation about themes and the files that go in them * add admin documentation for themes * fix markdown styling * fix CSSJanus usage
2021-02-02Add comprehensive user configuration in extensions (#3397)Gravatar Alexis Degrugillier
Before, the extension configuration was handled by its author. There was discrepancies between extensions on how the configuration was stored. Now, we could rely on a single way of storing configuration. This won't invalidate how the extensions are storing their configuration but will allow authors to focus on what is important.
2021-01-13Update extension documentation (#3352)Gravatar Alexis Degrugillier
Before the extension documentation was not very clear about the methods in the extension and how to use them. I hope that now it makes more sense.
2021-01-10Update and add to documentation (#3348)Gravatar ldv8434
* remove outdated mailing list information * add information about normal view * add information about global and reader view * fix import section header * reorder documentation to reflect menu's order * clarify setting as default in normal view * add info about reading section for config * fix heading levels, add info about archive + profile sections * unfix heading levels * move section on feed-specific settings to the subscription management page * update information about adding feeds, add information about feed management * fix link to security page in installation * fix broken links * fix broken link to install page * add lighttpd from project readme * add php modules to step 4, add horizontal line to better separate steps from footnotes visually * fix broken link * add index page for easier access of other pages * move first steps document * make dedicated bug reporting page * make index page for linking to other pages * moved fever API to relevant location, linked to index * remove outdated mailing list information * add information about normal view * add information about global and reader view * fix import section header * reorder documentation to reflect menu's order * clarify setting as default in normal view * add info about reading section for config * fix heading levels, add info about archive + profile sections * unfix heading levels * move section on feed-specific settings to the subscription management page * update information about adding feeds, add information about feed management * fix link to security page in installation * fix broken links * fix broken link to install page * add lighttpd from project readme * add php modules to step 4, add horizontal line to better separate steps from footnotes visually * fix broken link * add index page for easier access of other pages * move first steps document * make dedicated bug reporting page * make index page for linking to other pages * moved fever API to relevant location, linked to index * re-fix link * remove mention of defunct mailing list * grammar fix * replace stream with feed * add optional items, replace stream with feed * replace stream with feed * fix word choice Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * fix word choice better reflect age of project Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * grammar fixes Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * remove double headings Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * change single quote to double quote for consistency * add subreddit link * change php module list to Dockerfile link * fix link to developer index, change html links to md for consistency * update css selector terms Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
2021-01-09Add class autoload for extension (#3350)Gravatar Alexis Degrugillier
When an extension defines an `autoload` method, it will be registered automatically before enabling the extension. For the extension creator, it's easier because there is no need to register it manually.
2021-01-09Document the SQLite utilities usage (#3344)Gravatar Alexis Degrugillier
There is a CLI command to export from any database to a SQLite database and also a CLI command to import a SQLite database to any database than need to be documented. See #961
2021-01-07Update user query feature (#3338)Gravatar Alexis Degrugillier
* Change user query wording There was some misunderstanding in the use of the user query feature, probably because of the wording. I've change it to make it more obvious. * Fix feedback when a query is bookmarked Before, the displayed query name was not the one intended. Now, the name is the one of the current bookmark * Document user queries I've added a few words on how to use the user queries because it seems there was some misunderstanding. See #3219
2021-01-07two new hooks (#3342)Gravatar Clemens Neubauer
* add two new hooks I develop a new extension and i need 2 new hooks for it * update EN documentation * Correct typing errors * Update app/views/helpers/javascript_vars.phtml Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2021-01-03Adding info about combining css classes (#3329)Gravatar rom-1
* Adding info about combining css classes Adding info about combining css classes using comma separation * Update 05_Configuration.md * Apply suggestions from code review Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
2021-01-02Add section for text import (#3304)Gravatar Alexis Degrugillier
See #663
2020-12-31Update 03_Main_view.md (#3307)Gravatar rom-1
adding to documentation: filtering a tag with whitespace
2020-12-29Add a file for each PDO class (#3301)Gravatar Alexis Degrugillier
Before, we had 5 classes in the ModelPdo file. It was bad for 2 reasons. The first reason is that it is considered bad practice to have multiple class in one file. This is especially true when using autoloading. On top of that it is less readable considering the size of the file. The second reason is that so far we were lucky. Everytime we needed to access the database, it was through the ModelPdo class which loads all the other classes. If we want to access directly the connection, it wont be loaded. On top of that, the system is configured to work on a single database, but as we have every connection definition in a single file, all classes were loaded at the same time. Thus using memory and processing time for nothing. Now, we have a file for each class. To work with autoloading, classes were slightly renamed to match autoloading rules.
2020-12-28Revert "Add a file for each PDO class (#3297)"Gravatar Alexandre Alapetite
This reverts commit e1ee58816ba76734e4115fc12898b13de665b220.
2020-12-28Add a file for each PDO class (#3297)Gravatar Alexis Degrugillier
Before, we had 5 classes in the ModelPdo file. It was bad for 2 reasons. The first reason is that it is considered bad practice to have multiple class in one file. This is especially true when using autoloading. On top of that it is less readable considering the size of the file. The second reason is that so far we were lucky. Everytime we needed to access the database, it was through the ModelPdo class which loads all the other classes. If we want to access directly the connection, it wont be loaded. On top of that, the system is configured to work on a single database, but as we have every connection definition in a single file, all classes were loaded at the same time. Thus using memory and processing time for nothing. Now, we have a file for each class. To work with autoloading, classes were slightly renamed to match autoloading rules.
2020-11-12Update link to News+ Google Reader extension (#3252)Gravatar Alwaysin
* Remove News+ (Google Reader extension does not exist anymore) * Remove News+ (Google Reader extension does not exist anymore) * Update link to News+ Google Reader extension * Update link to News+ Google Reader extension * A few more links Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2020-10-15Update FAQ with firewall issues. (#3225)Gravatar tonitonae
* Update FAQ with firewall issues. * Update docs/en/users/07_Frequently_Asked_Questions.md Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr> Co-authored-by: tonitonae <tonitonae@zetmail.com> Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2020-10-03Optimize images (#3184)Gravatar Andrew Rabert
Used `oxipng --zopfli --opt max --strip all`
2020-08-18Docs: Add Fluent Reader to API Clients (#3140)Gravatar No Name Pro
* Docs: Add Fluent Reader to API Clients Fluent Reader is a desktop RSS reader built with Electron, React, and Fluent UI supporting Fever API. See more: https://github.com/yang991178/fluent-reader * RSS client list: Add section for cross plattform Adds in the RSS Client List a Section for Cross-Plattform Desktop Clients (Windows, Linux and MacOS) * Docs: API Clients: Table instead of List * Docs: API Clients: Change `Free Software` to `License` * Add me (No Name Pro) to Credits-File :) * Docs (FR): API Client List as table + Fluent Reader
2020-07-23Update doc about default configuration (#3124)Gravatar LucasVerneyDGE
See https://github.com/FreshRSS/FreshRSS/issues/3066
generated by cgit v1.2.3 (git 2.39.1) at 2026-02-11 02:34:50 +0000