Browse Source

Documentation update

J. King 3 months ago
parent
commit
37025bb49f
3 changed files with 25 additions and 14 deletions
  1. 3
    1
      CHANGELOG
  2. 2
    1
      README.md
  3. 20
    12
      UPGRADING

+ 3
- 1
CHANGELOG View File

@@ -1,15 +1,17 @@
1
-Version 0.6.0 (????-??-??)
1
+Version 0.6.0 (2019-01-21)
2 2
 ==========================
3 3
 
4 4
 New features:
5 5
 - Support for PostgreSQL databases
6 6
 - Support for MySQL databases
7
+- Validation of configuration parameters
7 8
 
8 9
 Bug fixes:
9 10
 - Use a general-purpose Unicode collation with SQLite databases
10 11
 
11 12
 Changes:
12 13
 - Improve performance of common database queries by 80-90%
14
+- Make configuration defaults consistent with their defined types
13 15
 
14 16
 Version 0.5.1 (2018-11-10)
15 17
 ==========================

+ 2
- 1
README.md View File

@@ -6,6 +6,7 @@ At present the software should be considered in an "alpha" state: though its cor
6 6
 
7 7
 - Providing more sync protocols (Google Reader, Fever, others)
8 8
 - Better packaging and configuration samples
9
+- A user manual
9 10
 
10 11
 ## Requirements
11 12
 
@@ -75,7 +76,7 @@ Please refer to `CONTRIBUTING.md` for guidelines on contributing code to The Ars
75 76
 
76 77
 Functionally there is no reason to prefer either SQLite or PostgreSQL over the other. SQLite is significantly simpler to set up in most cases, requiring only read and write access to a containing directory in order to function; PostgreSQL may perform better than SQLite when serving hundreds of users or more, though this has not been tested.
77 78
 
78
-MySQL, on the other hand, is *not recommended* due to its relatively constrained index prefix limits which may cause some newsfeeds which would otherwise work to be rejected. If using MySQL, special care should also be taken when performing schema upgrades, as errors during the process can leave the database in a half-upgraded state which The Arsse cannot itself recover from.
79
+MySQL, on the other hand, is **not recommended** due to its relatively constrained index prefix limits which may cause some newsfeeds which would otherwise work to be rejected. If using MySQL, special care should also be taken when performing schema upgrades, as errors during the process can leave the database in a half-upgraded state which The Arsse cannot itself recover from.
79 80
 
80 81
 Note that MariaDB is not compatible with The Arsse: its support for common table expressions is, as of this writing, not sufficient for our needs.
81 82
 

+ 20
- 12
UPGRADING View File

@@ -1,41 +1,49 @@
1 1
 General upgrade notes
2 2
 =====================
3 3
 
4
-When upgrading between any two versions of The Arsse, the following are usually prudent:
4
+When upgrading between any two versions of The Arsse, the following are 
5
+usually prudent:
5 6
 
6 7
 - Back up your database
7 8
 - Check for any changes to sample Web server configuration
8 9
 - Check for any changes to sample systemd unit or other init files
9
-- If installing from source, update dependencies with `composer install -o --no-dev`
10
+- If installing from source, update dependencies with:
11
+  `composer install -o --no-dev`
10 12
 
11 13
 
12 14
 Upgrading from 0.5.1 to 0.6.0
13 15
 =============================
14 16
 
15
-- The database schema has changed from rev3 to rev4; if upgrading the database manually, apply the 3.sql file
17
+- The database schema has changed from rev3 to rev4; if upgrading the database
18
+  manually, apply the 3.sql file
19
+- Configuration is now validated for type and semantics: some previously 
20
+  working configurations may no longer be accepted
16 21
 
17 22
 
18 23
 Upgrading from 0.2.1 to 0.3.0
19 24
 =============================
20 25
 
21 26
 - The following Composer dependencies have been added:
22
- - zendframework/zend-diactoros
23
- - psr/http-message
27
+    - zendframework/zend-diactoros
28
+    - psr/http-message
24 29
 
25 30
 
26 31
 Upgrading from 0.2.0 to 0.2.1
27 32
 =============================
28 33
 
29
-- The database schema has changed from rev2 to rev3; if upgrading the database manually, apply the 2.sql file
34
+- The database schema has changed from rev2 to rev3; if upgrading the database
35
+  manually, apply the 2.sql file
30 36
 
31 37
 
32 38
 Upgrading from 0.1.x to 0.2.0
33 39
 =============================
34 40
 
35
-- The database schema has changed from rev1 to rev2; if upgrading the database manually, apply the 1.sql file
36
-- Web server configuration has changed to accommodate Tiny Tiny RSS; the following URL paths are affected:
37
- - /tt-rss/api/
38
- - /tt-rss/feed-icons/
39
- - /tt-rss/images/
41
+- The database schema has changed from rev1 to rev2; if upgrading the database
42
+  manually, apply the 1.sql file
43
+- Web server configuration has changed to accommodate Tiny Tiny RSS; the
44
+  following URL paths are affected:
45
+    - /tt-rss/api/
46
+    - /tt-rss/feed-icons/
47
+    - /tt-rss/images/
40 48
 - The following Composer dependencies have been added:
41
- - jkingweb/druuid
49
+    - jkingweb/druuid

Loading…
Cancel
Save