Commit Graph

25 Commits

Author SHA1 Message Date
Dietmar Maurer
b9a09a9501 docs: add "Configuration Files" appendix 2021-02-10 11:28:56 +01:00
Thomas Lamprecht
02dce8cad0 docs: index: update copyright years
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-02-04 16:06:38 +01:00
Dominik Csapak
1531185dd0 docs: explain some technical details about datastores/chunks
adds explanations for:
* what datastores are
* their relation with snapshots/chunks
* basic information about chunk directory structures
* fixed-/dynamically-sized chunks
* special handling of encrypted chunks
* hash collision probability
* limitation of file-based backups

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2021-02-04 11:30:42 +01:00
Dylan Whyte
04e24b14f0 Restructure docs (more first level headings)
This removes the "Backup Management" first level heading in the docs,
and either uses the sub headings contained within it as first level
headings, or groups previous sections logically under new headings.

The administration-guide.rst file is also removed. Its contents are
instead separated into various files, that relate to their respective
first level heading.

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
2020-10-05 09:23:45 +02:00
Thomas Lamprecht
bc8fadf494 docs: index: hide todo list toctree and genindex
I do not found another way to disable inclusion in the sidebar...

The genindex information is alredy provided through glossary

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-09-24 19:43:18 +02:00
Thomas Lamprecht
796480a38b docs: add version and date to HTML index
Similar to the PDF output or the Proxmox VE docs.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-09-22 09:00:12 +02:00
Dominik Csapak
1eff9a1e89 docs: add section for calendar events
and move the info defined in 'Schedules' there,
the explanation of calendar events is inspired by the systemd.time
manpage and the pve docs (especially the examples are mostly
copied/adapted from there)

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2020-09-11 12:17:42 +02:00
Thomas Lamprecht
d937daedb3 docs: set html img width limitation through css
avoid hardcoding width in the docs itself, so that other render
outputs can choose another size.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-09-11 11:10:08 +02:00
Dylan Whyte
1de47507ff Add section "FAQ"
Adds an FAQ to the docs, based on question that have
been appearing on the forum.

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
2020-09-10 11:33:00 +02:00
Thomas Lamprecht
33a87bc39a docs: reference PDF variant in HTML output
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-07-09 21:31:38 +02:00
Thomas Lamprecht
24406ebc0c docs: move host sysadmin out to own chapter, fix ZFS one
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-07-08 18:15:33 +02:00
Thomas Lamprecht
3a9988638b docs: move todolist to own document, don't link in release build
It is always build for html, but not linked if the devbuild tag isn't
set. This tag is set in the Makefile if the $(BUILD_MODE) variable
isn't "release".

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-07-06 14:44:53 +02:00
Thomas Lamprecht
8a25809573 docs: sync up copyright years
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-07-04 17:57:47 +02:00
Thomas Lamprecht
27f86f997e docs: fix index title
Contributed-by: Daniela Häsler <daniela@proxmox.com>
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-07-03 18:57:04 +02:00
Dietmar Maurer
210cb53654 docs: enable sphinx todo items 2019-11-16 11:16:04 +01:00
Dietmar Maurer
c4f1b69f4e docs: add sysadmin.rst, cleanups 2019-11-15 13:24:45 +01:00
Dietmar Maurer
cb01363cfa docs: rename deployment-guide.rst -> administration-guide.rst
and join with admin-guide.rst
2019-11-15 12:35:31 +01:00
Dietmar Maurer
022b8350d9 add license for docs (GFDL) 2019-11-11 19:45:44 +01:00
Dietmar Maurer
177db84b82 docs/backup-protocol.rst: add backup protocol docs 2019-06-04 17:33:12 +02:00
Dietmar Maurer
164d961729 docs/index.rst: cleanup 2019-03-19 12:22:57 +01:00
Dietmar Maurer
998b827a5d start file format docu 2019-03-16 16:44:45 +01:00
Dietmar Maurer
d49746481c docs: remove generated-index.rst and search-page.rst
This does not work as expected.
2019-03-05 18:36:22 +01:00
Dietmar Maurer
d823802ea1 docs: add glossary.rst 2019-02-28 19:09:55 +01:00
Dietmar Maurer
7e688b7149 docs: improve ducument structure 2019-02-27 18:35:05 +01:00
Dietmar Maurer
7ef486ae06 build doc with sphinx 2019-02-27 17:42:31 +01:00