Commit Graph

142 Commits

Author SHA1 Message Date
Alexandre Alapetite
1acd3ab09b 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
2022-01-08 21:58:55 +01:00
Thomas Renes
916df412f5 Fix various typos and spelling errors in documentation, comments and code. (#4134) 2022-01-08 16:25:17 +01:00
Alexis Degrugillier
127b7f0a3a Change i18n process (#4131)
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-08 14:00:26 +01:00
Alexandre Alapetite
1335a0e3cf PHPStan level 5 (#4110)
* 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
2022-01-04 13:59:09 +01:00
Alexandre Alapetite
fb15a2d804 Search on article IDs (#4058)
* Search on article IDs
Partial implementation of https://github.com/FreshRSS/FreshRSS/issues/4053
2021-12-31 13:10:41 +01:00
maTh
078dc65cbc Improved manual: User Management/User registration (#4083)
* 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-26 12:47:17 +01:00
4xfu
3340235540 Correct cron example (#4079)
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-23 12:26:34 +01:00
maTh
ed8703e674 Improved: Manual: username+pw for demo login (#4072)
* added: username+pw for demo login

* fix white spaces
2021-12-20 20:48:01 +01:00
happymacarts
f0ca1288d2 Update 02_First_steps.md (#4049)
spelling correction of "available"
2021-12-10 11:48:50 +01:00
xnaas
1595d557b0 Fix typo of 'envelope' and reference De Morgan's laws (#3991) 2021-11-24 09:05:18 +01:00
Alexandre Alapetite
0d31f89dd8 Remove remains of Travis (#3941)
* 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-11-02 23:46:26 +01:00
Kaibin Yang
6660a2dded Add a reminder for NGINX installations (#3741) (#3934)
Update docs/en/admins/03_Installation.md
2021-10-25 20:26:09 +02:00
Alexandre Alapetite
88e47dba80 Hot fix broken links documentation
Bug from https://github.com/FreshRSS/FreshRSS/pull/3905
2021-10-24 18:23:50 +02:00
Alexandre Alapetite
acbba9adb2 Improved markdownlint (#3918)
* 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-23 13:43:24 +02:00
Felix Bühler
915dcc3ccc Split fever & greader into two separate pages. (#3905)
* [docs] add newsflash to fever-clients

* [docs] split fever&greader-apis into two pages and make the more consistent
2021-10-23 13:32:20 +02:00
OctopusET
1f8fd53c3f Update Korean Translation with language code fix (#3914)
* 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-10-23 12:14:16 +02:00
Alexis Degrugillier
3ae7474614 Fix documentation typo (#3810)
See #3809
2021-08-30 15:11:23 +02:00
maTh
051cf5be10 docs (#3784) 2021-08-20 14:06:00 +02:00
maTh
9234a8a39a Fix docs link to dev themes (#3746)
* link fixed

* fix2
2021-08-14 12:23:16 +02:00
Alexandre Alapetite
705be9a6a1 Search labels (#3709)
* 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-24 19:32:43 +02:00
Alexis Degrugillier
714b40e2de Add system configuration for extension (#3626)
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-07-11 15:11:10 +02:00
Frans de Jonge
2733fe1fd3 [docs] Fix typo in server requirements (#3681) 2021-06-29 13:35:01 +02:00
Alexandre Alapetite
483b6eb333 Drop PHP5 and IE11 (#3666)
* 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-07 17:53:47 +02:00
marcohald
c23e0136d0 Update 08_FeedUpdates.md (#3635)
* 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-06-06 22:32:12 +02:00
Strubbl
7a350bf3ac Update README.md (#3601)
* Update README.md

Readably is not available anymore

* More lines to remove

Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2021-05-04 21:49:36 +02:00
Petra Lamborn
90ea2156f6 Newsboat support (#3574)
* 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 <f18145fc98> 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-04-08 18:32:27 +02:00
berumuron
cc6c529562 tec: Remove data/do-install.txt (#3555)
* 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-26 19:41:33 +01:00
Alexandre Alapetite
1c3159058f Quick update the doc for master renaming to edge 2021-03-15 00:00:25 +01:00
Alexandre Alapetite
b455b29c8c FocusReader (#3514) 2021-03-10 20:28:58 +01:00
Alexis Degrugillier
787e8fa463 Add user maintenance hooks (#3440)
The new hook allows to add maintenance extensions at the user level.

See #3398
2021-02-17 16:34:54 +01:00
Lukas Vacula
a3f07d7d5e Theme Documentation (#3415)
* 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-06 16:46:03 +01:00
Alexis Degrugillier
8285f1df43 Add comprehensive user configuration in extensions (#3397)
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-02-02 00:03:09 +01:00
Alexis Degrugillier
b43b94dff8 Update extension documentation (#3352)
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-13 18:42:57 +01:00
ldv8434
bf344cd302 Update and add to documentation (#3348)
* 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-10 20:50:54 +01:00
Alexis Degrugillier
f5fdbb9e82 Add class autoload for extension (#3350)
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-09 20:49:45 +01:00
Alexis Degrugillier
5e4c392cf2 Document the SQLite utilities usage (#3344)
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-09 01:45:36 +01:00
Alexis Degrugillier
85cbfcedb5 Update user query feature (#3338)
* 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-07 21:47:39 +01:00
Clemens Neubauer
ef458992c1 two new hooks (#3342)
* 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-07 21:45:48 +01:00
rom-1
aa3e41d4b3 Adding info about combining css classes (#3329)
* 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-03 20:37:57 +01:00
Alexis Degrugillier
082ef9854c Add section for text import (#3304)
See #663
2021-01-02 17:37:26 +01:00
rom-1
71c541db7f Update 03_Main_view.md (#3307)
adding to documentation: filtering a tag with whitespace
2020-12-31 14:50:13 +01:00
Alexis Degrugillier
3f4c86f80f Add a file for each PDO class (#3301)
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-29 00:11:34 +01:00
Alexandre Alapetite
0a2d9b3b54 Revert "Add a file for each PDO class (#3297)"
This reverts commit e1ee58816b.
2020-12-28 19:53:55 +01:00
Alexis Degrugillier
e1ee58816b Add a file for each PDO class (#3297)
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-28 16:44:08 +01:00
Alwaysin
fdf40c95b9 Update link to News+ Google Reader extension (#3252)
* 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-11-12 11:52:52 +01:00
tonitonae
fdfe6e7038 Update FAQ with firewall issues. (#3225)
* 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-15 10:27:43 +02:00
Andrew Rabert
e65544d39e Optimize images (#3184)
Used `oxipng --zopfli --opt max --strip all`
2020-10-03 13:42:18 +02:00
No Name Pro
162f31f82e Docs: Add Fluent Reader to API Clients (#3140)
* 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-08-18 15:01:14 +02:00
LucasVerneyDGE
12d2baf64d Update doc about default configuration (#3124)
See https://github.com/FreshRSS/FreshRSS/issues/3066
2020-07-23 11:26:11 +02:00
Marien Fressinaud
8619cf6fa6 Add a migration system (#2760)
* Add a Minz_Migrator class

Until now, we updated the database structure somewhere in the code but
it wasn't always consistent and somehow complicated to find. Also, this
code was always checked for nothing.

The Migrator aims to improve and ease the creation of migrations. It
should improve the way we apply the updates, making the update server
almost useless.

References:

- example of migration (before Migrator): cc0db9af4f (diff-11a53443fa81512b128c66b065df0679R10)
- update server: https://github.com/FreshRSS/update.freshrss.org
- PR moving the code of the update server to the core: https://github.com/FreshRSS/FreshRSS/pull/1760

* Automatically apply migrations

For now, administrators are used to have nothing to do during an update
else than getting the new code. I suggest to keep this behaviour and
automatically apply migrations if we detect new ones.

Another solution would be to create a CLI command and ask admins to call
it after getting the new code. It could hide migrations errors to end
users, but admin can forget to apply migrations since there are not used
to it.

* Add documentation for Minz Migrator

* Execute migrations even if next ones are applied

* Change mechanism to prevent multiple update at once

* Use mkdir to create the lock and to test it exists

Reference: https://stackoverflow.com/a/731634

* Append .lock to applied_migrations_path

There are no needs to define another file to serve as a lock.

* Change migrations naming convention

* Apply suggestions from code review

Co-Authored-By: Alexandre Alapetite <alexandre@alapetite.fr>

* Perform a low-cost migration versions comparaison

* Clarify version numbers concerning the migration system

Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2020-07-08 12:11:55 +02:00