Skip to content

Commit 9362b00

Browse files
committed
Use regular ids
1 parent 51c9735 commit 9362b00

File tree

1 file changed

+44
-44
lines changed

1 file changed

+44
-44
lines changed

DOCUMENTATION.md

Lines changed: 44 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ to http://localhost:5232/ with your browser!
3131
You can login with any username and password.
3232

3333
Want more? Why don't you check our wonderful
34-
[documentation](#documentation)?
34+
[documentation](#documentation-1)?
3535

3636
#### What's New?
3737

@@ -45,41 +45,41 @@ released on May 19, 2020
4545

4646
This documentation page is written for version 2.x.x. If you want to update
4747
Radicale from 1.x.x to 2.x.x, please follow
48-
our [migration guide](#documentation/migration-from-1xx-to-2xx). You can find on GitHub the
48+
our [migration guide](#migration-from-1xx-to-2xx). You can find on GitHub the
4949
[documentation page for the 1.1.x versions](1.1.x.html).
5050

5151
#### Install and Set Up
5252

5353
You're new to Radicale and you want to know how to use it? Welcome aboard!
5454

5555
- [What is Radicale?](#about)
56-
- [A really simple 5-minute tutorial.](#documentation/tutorial)
57-
- [A simple but solid setup.](#documentation/basic-setup)
58-
- [Run behind a reverse proxy.](#documentation/reverse-proxy)
59-
- [Run with a WSGI server.](#documentation/wsgi)
60-
- [Track all changes to calendars and address books with Git.](#documentation/versioning)
56+
- [A really simple 5-minute tutorial.](#tutorial)
57+
- [A simple but solid setup.](#basic-setup)
58+
- [Run behind a reverse proxy.](#reverse-proxy)
59+
- [Run with a WSGI server.](#wsgi)
60+
- [Track all changes to calendars and address books with Git.](#versioning)
6161

6262
#### Use
6363

64-
- [Which clients are supported?](#documentation/clients)
64+
- [Which clients are supported?](#clients)
6565

6666
#### Configure
6767

6868
Now that you have Radicale running, let's see what we can configure to make it
6969
fit your needs.
7070

71-
- [What can I configure?](#documentation/configuration)
72-
- [Authentication & Rights.](#documentation/authentication-and-rights)
73-
- [Storage.](#documentation/storage)
74-
- [Logging.](#documentation/logging)
71+
- [What can I configure?](#configuration-1)
72+
- [Authentication & Rights.](#authentication-and-rights)
73+
- [Storage.](#storage-2)
74+
- [Logging.](#logging-1)
7575

7676
#### Hack
7777

7878
Using is fun, but hacking is soooooooo coooooool. Radicale is a really small
7979
and simple piece of code, it may be the perfect project to start hacking!
8080

81-
- [How does Radicale work?](#documentation/architecture)
82-
- [Plugins.](#documentation/plugins)
81+
- [How does Radicale work?](#architecture)
82+
- [Plugins.](#plugins)
8383
- [Adding or fixing documentation.](#contribute)
8484

8585
### Tutorial
@@ -88,11 +88,11 @@ You want to try Radicale but only have 5 minutes free in your calendar? Let's
8888
go right now! You won't have the best installation ever, but it will be enough
8989
to play a little bit with Radicale.
9090

91-
When everything works, you can get a [client](#documentation/clients) and
91+
When everything works, you can get a [client](#clients) and
9292
start creating calendars and address books. The server **only** binds to
9393
localhost (is **not** reachable over the network) and you can log in with any
9494
user name and password. If Radicale fits your needs, it may be time for
95-
[some basic configuration](#documentation/basic-setup).
95+
[some basic configuration](#basic-setup).
9696

9797
Follow one of the chapters below depending on your operating system.
9898

@@ -141,7 +141,7 @@ You can login with any username and password.
141141
### Basic Setup
142142

143143
Installation instructions can be found on the
144-
[Tutorial](#documentation/tutorial) page.
144+
[Tutorial](#tutorial) page.
145145

146146
#### Configuration
147147

@@ -155,7 +155,7 @@ You should create a new configuration file at the desired location.
155155
passed via command line arguments.)
156156

157157
All configuration options are described in detail on the
158-
[Configuration](#documentation/configuration) page.
158+
[Configuration](#configuration-1) page.
159159

160160
#### Authentication
161161

@@ -359,7 +359,7 @@ Set the configuration option `daemon` in the section `server` to `True`.
359359
You may want to set the option `pid` to the path of a PID file.
360360

361361
After daemonization the server will not log anything. You have to configure
362-
[Logging](#documentation/logging).
362+
[Logging](#logging-1).
363363

364364
If you start Radicale now, it will initialize and fork into the background.
365365
The main process exits, after the PID file is written.
@@ -969,7 +969,7 @@ Default: `owner_only`
969969
##### file
970970

971971
File for the rights backend `from_file`. See the
972-
[Rights](#documentation/authentication-and-rights) page.
972+
[Rights](#authentication-and-rights) page.
973973

974974
#### storage
975975
##### type
@@ -1014,7 +1014,7 @@ Default: `True`
10141014
##### hook
10151015

10161016
Command that is run after changes to storage. Take a look at the
1017-
[Versioning](#documentation/versioning) page for an example.
1017+
[Versioning](#versioning) page for an example.
10181018

10191019
Default:
10201020

@@ -1054,7 +1054,7 @@ Default: `True`
10541054

10551055
##### config
10561056

1057-
Logging configuration file. See the [Logging](#documentation/logging) page.
1057+
Logging configuration file. See the [Logging](#logging-1) page.
10581058

10591059
Default:
10601060

@@ -1132,7 +1132,7 @@ It's safe to access and manipulate the data by hand or with scripts.
11321132
Scripts can be invoked manually, periodically (e.g. with
11331133
[cron](https://manpages.debian.org/unstable/cron/cron.8.en.html)) or after each
11341134
change to the storage with the configuration option `hook` in the `storage`
1135-
section (e.g. [Git Versioning](#documentation/versioning)).
1135+
section (e.g. [Git Versioning](#versioning)).
11361136

11371137
#### Layout
11381138

@@ -1538,7 +1538,7 @@ There's now only one way to store data in Radicale: collections are stored as
15381538
folders and events / contacts are stored in files. This new storage is close to
15391539
the `multifilesystem`, but **it's now thread-safe, with atomic writes and file
15401540
locks**. Other storage types can be used by creating
1541-
[plugins](#documentation/plugins).
1541+
[plugins](#plugins).
15421542

15431543
To migrate data to Radicale 2.x.x the command line argument
15441544
``--export-storage`` was added to Radicale 1.1.x.
@@ -1564,23 +1564,23 @@ $ python3 -m pip install --upgrade radicale==1.1.*
15641564

15651565
**Radicale 2.x.x only provides htpasswd authentication out-of-the-box.** Other
15661566
authentication methods can be added by creating or using
1567-
[plugins](#documentation/plugins).
1567+
[plugins](#plugins).
15681568

15691569
#### Rights
15701570

15711571
In Radicale 2.x.x, rights are managed using regex-based rules based on the
15721572
login of the authenticated user and the URL of the resource. Default
15731573
configurations are built in for common cases, you'll find more about this on
1574-
the [Authentication & Rights](#documentation/authentication-and-rights) page.
1574+
the [Authentication & Rights](#authentication-and-rights) page.
15751575

15761576
Other rights managers can be added by creating
1577-
[plugins](#documentation/plugins).
1577+
[plugins](#plugins).
15781578

15791579
#### Versioning
15801580

15811581
Support for versioning with **git** was removed from Radicale 2.x.x.
15821582
Instead, the configuration option ``hook`` in the ``storage`` section was added,
1583-
the [Collection Versioning](#documentation/versioning) page explains its
1583+
the [Collection Versioning](#versioning) page explains its
15841584
usage for version control.
15851585

15861586
## Contribute
@@ -1755,7 +1755,7 @@ steps to have a simple remote calendar and contact access.
17551755
Contrary to other servers that are often complicated, require high privileges
17561756
or need a strong configuration, the Radicale Server can (sometimes, if not
17571757
often) be launched in a couple of minutes, if you follow the
1758-
[tutorial](#documentation/tutorial).
1758+
[tutorial](#tutorial).
17591759

17601760
##### Lazy
17611761

@@ -1798,7 +1798,7 @@ Radicale 2.1.12 is out!
17981798
#### 2.1.12 - Wild Radish
17991799

18001800
This release is compatible with version 2.0.0. Follow our
1801-
[migration guide](#documentation/migration-from-1xx-to-2xx) if you want to switch
1801+
[migration guide](#migration-from-1xx-to-2xx) if you want to switch
18021802
from 1.x.x to 2.x.x.
18031803

18041804
* Include documentation in source archive
@@ -1810,7 +1810,7 @@ Radicale 2.1.11 is out!
18101810
#### 2.1.11 - Wild Radish
18111811

18121812
This release is compatible with version 2.0.0. Follow our
1813-
[migration guide](#documentation/migration-from-1xx-to-2xx) if you want to switch
1813+
[migration guide](#migration-from-1xx-to-2xx) if you want to switch
18141814
from 1.x.x to 2.x.x.
18151815

18161816
* Fix moving items between collections
@@ -1822,7 +1822,7 @@ Radicale 2.1.10 is out!
18221822
#### 2.1.10 - Wild Radish
18231823

18241824
This release is compatible with version 2.0.0. Follow our
1825-
[migration guide](#documentation/migration-from-1xx-to-2xx) if you want to switch
1825+
[migration guide](#migration-from-1xx-to-2xx) if you want to switch
18261826
from 1.x.x to 2.x.x.
18271827

18281828
* Update required versions for dependencies
@@ -1839,7 +1839,7 @@ Radicale 2.1.9 is out!
18391839
#### 2.1.9 - Wild Radish
18401840

18411841
This release is compatible with version 2.0.0. Follow our
1842-
[migration guide](#documentation/migration-from-1xx-to-2xx) if you want to switch
1842+
[migration guide](#migration-from-1xx-to-2xx) if you want to switch
18431843
from 1.x.x to 2.x.x.
18441844

18451845
* Specify versions for dependencies
@@ -1857,7 +1857,7 @@ Radicale 2.1.8 is out!
18571857
#### 2.1.8 - Wild Radish
18581858

18591859
This release is compatible with version 2.0.0. Follow our
1860-
[migration guide](#documentation/migration-from-1xx-to-2xx) if you want to switch
1860+
[migration guide](#migration-from-1xx-to-2xx) if you want to switch
18611861
from 1.x.x to 2.x.x.
18621862

18631863
* Flush files before fsync'ing
@@ -1869,7 +1869,7 @@ Radicale 2.1.7 is out!
18691869
#### 2.1.7 - Wild Radish
18701870

18711871
This release is compatible with version 2.0.0. Follow our
1872-
[migration guide](#documentation/migration-from-1xx-to-2xx) if you want to switch
1872+
[migration guide](#migration-from-1xx-to-2xx) if you want to switch
18731873
from 1.x.x to 2.x.x.
18741874

18751875
* Don't print warning when cache format changes
@@ -1895,7 +1895,7 @@ Radicale 2.1.6 is out!
18951895
#### 2.1.6 - Wild Radish
18961896

18971897
This release is compatible with version 2.0.0. Follow our
1898-
[migration guide](#documentation/migration-from-1xx-to-2xx) if you want to switch
1898+
[migration guide](#migration-from-1xx-to-2xx) if you want to switch
18991899
from 1.x.x to 2.x.x.
19001900

19011901
* Fix content-type of VLIST
@@ -1914,7 +1914,7 @@ Radicale 2.1.5 is out!
19141914
#### 2.1.5 - Wild Radish
19151915

19161916
This release is compatible with version 2.0.0. Follow our
1917-
[migration guide](#documentation/migration-from-1xx-to-2xx) if you want to switch
1917+
[migration guide](#migration-from-1xx-to-2xx) if you want to switch
19181918
from 1.x.x to 2.x.x.
19191919

19201920
* Add ``--verify-storage`` command-line argument
@@ -1931,7 +1931,7 @@ Radicale 2.1.4 is out!
19311931
#### 2.1.4 - Wild Radish
19321932

19331933
This release is compatible with version 2.0.0. Follow our
1934-
[migration guide](#documentation/migration-from-1xx-to-2xx) if you want to switch
1934+
[migration guide](#migration-from-1xx-to-2xx) if you want to switch
19351935
from 1.x.x to 2.x.x.
19361936

19371937
* Fix incorrect time range matching and calculation for some edge-cases with
@@ -1945,7 +1945,7 @@ Radicale 2.1.3 is out!
19451945
#### 2.1.3 - Wild Radish
19461946

19471947
This release is compatible with version 2.0.0. Follow our
1948-
[migration guide](#documentation/migration-from-1xx-to-2xx) if you want to switch
1948+
[migration guide](#migration-from-1xx-to-2xx) if you want to switch
19491949
from 1.x.x to 2.x.x.
19501950

19511951
* Enable timeout for SSL handshakes and move them out of the main thread
@@ -1960,7 +1960,7 @@ Radicale 2.1.2 is out!
19601960
#### 2.1.2 - Wild Radish
19611961

19621962
This release is compatible with version 2.0.0. Follow our
1963-
[migration guide](#documentation/migration-from-1xx-to-2xx) if you want to switch
1963+
[migration guide](#migration-from-1xx-to-2xx) if you want to switch
19641964
from 1.x.x to 2.x.x.
19651965

19661966
* Remove workarounds for bugs in VObject < 0.9.5
@@ -1976,7 +1976,7 @@ Radicale 2.1.1 is out!
19761976
#### 2.1.1 - Wild Radish Again
19771977

19781978
This release is compatible with version 2.0.0. Follow our
1979-
[migration guide](#documentation/migration-from-1xx-to-2xx) if you want to switch
1979+
[migration guide](#migration-from-1xx-to-2xx) if you want to switch
19801980
from 1.x.x to 2.x.x.
19811981

19821982
* Add missing UIDs instead of failing
@@ -1990,7 +1990,7 @@ Radicale 2.1.0 is out!
19901990
#### 2.1.0 - Wild Radish
19911991

19921992
This release is compatible with version 2.0.0. Follow our
1993-
[migration guide](#documentation/migration-from-1xx-to-2xx) if you want to switch
1993+
[migration guide](#migration-from-1xx-to-2xx) if you want to switch
19941994
from 1.x.x to 2.1.0.
19951995

19961996
* Built-in web interface for creating and managing address books and calendars
@@ -2029,7 +2029,7 @@ Radicale 2.0.0 is out!
20292029
#### 2.0.0 - Little Big Radish
20302030

20312031
This feature is not compatible with the 1.x.x versions. Follow our
2032-
[migration guide](#documentation/migration-from-1xx-to-2xx) if you want to switch
2032+
[migration guide](#migration-from-1xx-to-2xx) if you want to switch
20332033
from 1.x.x to 2.0.0.
20342034

20352035
- Support Python 3.3+ only, Python 2 is not supported anymore
@@ -2651,7 +2651,7 @@ After a lot of help and testing work from Andrew, Björn, Anders, Dorian and
26512651
Pete (and other ones we could have forgotten), a simple iPhone support has been
26522652
added in the git repository. If you are interested, you can test this feature
26532653
*right now* by
2654-
[downloading the latest git version](#download//git-repository)
2654+
[downloading the latest git version](#git-repository)
26552655
(a tarball is even available too if you don't want or know how to use git).
26562656

26572657
No documentation has been written yet, but using the right URL in the

0 commit comments

Comments
 (0)