Skip to content

Commit a8edc01

Browse files
committed
docs: Annotate features requiring 2.20
We had several people confused by the docs.
1 parent 34c6e5d commit a8edc01

File tree

5 files changed

+41
-3
lines changed

5 files changed

+41
-3
lines changed

docs/content/docs/administration/options.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ number of entries per page on your stream
8282
### `items_lifetime`
8383
<div class="config-option">
8484

85-
Number of days since the item has been last seen after which it can be deleted. Set to `0` to disable item deletion. Starred items will never be deleted.
85+
Number of days since the item has been last seen after which it can be deleted. In the upcoming selfoss 2.20, you can set it to `0` to disable item deletion. Starred items will never be deleted.
8686
</div>
8787

8888
### `base_url`
@@ -196,7 +196,7 @@ set `0` or leave empty for auto detection (browser language) or use one of the f
196196
* Slovak: `sk`
197197
* Spanish: `es`
198198
* Swedish: `sv`
199-
* Tamil: `ta`
199+
* Tamil: `ta` (will only be available in selfoss 2.20 or later)
200200
* Turkish: `tr`
201201
* Ukrainian: `uk`
202202
</div>
@@ -218,7 +218,7 @@ Set to `1` to allow public access for `/update` (anybody can access and start th
218218
<dt><code>t</code></dt><dd>Twitter</dd>
219219
<dt><code>p</code></dt><dd>Pocket</dd>
220220
<dt><code>d</code></dt><dd>Diaspora</dd>
221-
<dt><code>m</code></dt><dd>Mastodon (requires <a href="#mastodon"><code>mastodon</code></a> option to be set)</dd>
221+
<dt><code>m</code></dt><dd>Mastodon (requires <a href="#mastodon"><code>mastodon</code></a> option to be set, will only be available in selfoss 2.20 or later)</dd>
222222
<dt><code>w</code></dt><dd>Wallabag (requires <a href="#wallabag"><code>wallabag</code></a> option to be set)</dd>
223223
<dt><code>s</code></dt><dd>Wordpress (requires <a href="#wordpress"><code>wordpress</code></a> option to be set)</dd>
224224
<dt><code>e</code></dt><dd>E-mail</dd>

docs/content/docs/customization/spouts/index.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,14 @@ If you want to get the newest entries from your own source (e.g. an IMAP e-mail
1919

2020
Create a new PHP file under `src/spouts/your_spouts/your_spout.php` (choose a name for `your_spouts` and `your_spout`). The easiest way is to copy the [`src/spouts/rss/feed.php`](https://github.com/fossar/selfoss/blob/master/src/spouts/rss/feed.php) and to modify this file.
2121

22+
<div class="admonition warning">
23+
24+
## Warning
25+
26+
The following documentation targets the upcoming selfoss 2.20. You can read about the changes in [NEWS](https://github.com/fossar/selfoss/blob/master/NEWS.md#customization-changes).
27+
28+
</div>
29+
2230
### Member Variables
2331
Set the `$name` and `$description` variable with the name and description of your spout. The `$params` contain the definition of the input fields which a user will have to fill to add a new source of your spout (e.g. `username` and `password` for accessing the source data).
2432

docs/content/docs/project/release-checklist.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ weight = 40
44
+++
55

66
1. Update `NEWS.md` with highlights of changes that are not yet there. Set a release date.
7+
2. Revert <https://github.com/fossar/selfoss/pull/1521>.
78
2. Update the version strings throughout the code base to the new release using `npm run bump-version 2.19` and commit the changes.
89
3. Commit the changes.
910
4. Create a tag using `git tag 2.19`.

docs/content/docs/usage/filters.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@ weight = 40
55

66
You can limit which items of sources will be stored in the database by specifying a filter expression in the “Filter” field of a source on the Settings page.
77

8+
<div class="admonition warning">
9+
10+
## Warning
11+
12+
The *field-specific* or *negated* filters require the upcoming selfoss 2.20. Older versions only support *atomic filters*.
13+
14+
</div>
15+
816
The filter expression can take one of the following forms:
917

1018
1. An *atomic filter*: a Perl-compatible regular expression, as [accepted by PHP](https://www.php.net/manual/en/reference.pcre.pattern.syntax.php), between forward slashes (`/`). For example, `/reg(ular expression|ex)/` will keep only items whose title or content matches the regular expression between the slashes (i.e. contain the phrase “regular expression” or “regex”). Learn more about regular expressions on <https://www.regular-expressions.info/>.

docs/sass/style.scss

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -451,3 +451,24 @@ kbd {
451451
.footnote-definition-label {
452452
margin-right: 0.95rem;
453453
}
454+
455+
// Admonitions
456+
.admonition {
457+
background: #d4d4d244;
458+
border-left: 0.3rem solid #d4d4d2;
459+
padding: 1rem;
460+
border-radius: 0.3rem;
461+
}
462+
463+
.admonition h2 {
464+
margin: 0;
465+
}
466+
467+
.admonition.warning {
468+
background: #d9770644;
469+
border-left-color: #d97706;
470+
}
471+
472+
.admonition.warning h2 {
473+
color: #d97706;
474+
}

0 commit comments

Comments
 (0)