borg/docs/index.rst

.. include:: global.rst.inc


Borg Documentation
==================

.. include:: ../README.rst

.. toctree::
   :maxdepth: 2

   installation
   quickstart
   usage
   faq
   support
   resources
   changes
   internals
   development
   authors
Docs improvements 2013-06-29 21:56:44 +00:00			`.. include:: global.rst.inc`
Initial documentation 2011-11-05 18:42:28 +00:00
docs: install docs, faq improvements, other minor changes 2015-05-14 18:47:08 +00:00
deduplicate and refactor the docs README.rst (shown on github and also at the start of the html docs) shall be like an elevator speech - convince readers in a very short time. this is most important, everything else can come after we got the reader's interest. include README into docs to avoid duplication. also include CHANGES into docs. add developer docs, move examples from tox.ini there add separate support docs remove glossary, most of what was there can be understood by an admin from context move attic and compatibility note to the end 2015-08-06 10:59:51 +00:00			`Borg Documentation`
			`==================`
Initial documentation 2011-11-05 18:42:28 +00:00
show the README on the homepage instead of a boring table of contents, try to show our more exciting README file it's still a wall of text, but at least all the buzzwords and highlights are there ideally, the table of contents would be in the sidebar, but i don't know how to do that 2015-10-07 21:56:24 +00:00			`.. include:: ../README.rst`

Docs improvements 2013-06-29 21:56:44 +00:00			`.. toctree::`
			`:maxdepth: 2`
Initial documentation 2011-11-05 18:42:28 +00:00
Added more installation documentation. 2013-06-30 19:30:17 +00:00			`installation`
More documentation work 2013-07-31 18:51:01 +00:00			`quickstart`
Renamed commands.rst to usage.rst 2013-08-04 19:23:12 +00:00			`usage`
Docs improvements 2013-06-29 21:56:44 +00:00			`faq`
deduplicate and refactor the docs README.rst (shown on github and also at the start of the html docs) shall be like an elevator speech - convince readers in a very short time. this is most important, everything else can come after we got the reader's interest. include README into docs to avoid duplication. also include CHANGES into docs. add developer docs, move examples from tox.ini there add separate support docs remove glossary, most of what was there can be understood by an admin from context move attic and compatibility note to the end 2015-08-06 10:59:51 +00:00			`support`
docs: add resources section, with videos, talks, presentations 2015-12-03 15:58:48 +00:00			`resources`
deduplicate and refactor the docs README.rst (shown on github and also at the start of the html docs) shall be like an elevator speech - convince readers in a very short time. this is most important, everything else can come after we got the reader's interest. include README into docs to avoid duplication. also include CHANGES into docs. add developer docs, move examples from tox.ini there add separate support docs remove glossary, most of what was there can be understood by an admin from context move attic and compatibility note to the end 2015-08-06 10:59:51 +00:00			`changes`
clarify some bits I missed 2014-12-16 15:03:20 +00:00			`internals`
deduplicate and refactor the docs README.rst (shown on github and also at the start of the html docs) shall be like an elevator speech - convince readers in a very short time. this is most important, everything else can come after we got the reader's interest. include README into docs to avoid duplication. also include CHANGES into docs. add developer docs, move examples from tox.ini there add separate support docs remove glossary, most of what was there can be understood by an admin from context move attic and compatibility note to the end 2015-08-06 10:59:51 +00:00			`development`
include authors, and move to docs also keep a symlink for backwards compatibility 2015-10-07 21:47:34 +00:00			`authors`