Commit 0bd4e01a authored by Maciej Delmanowski's avatar Maciej Delmanowski

Redesign documentation structure

The previous documentation had a constrained design due to being spread
among separate 'git' repositories. The new documentation is in one
place, therefore it can have better structure.

The old documentation is still available for the time being.
parent 0f750a2e
DebOps role index
=================
Index of DebOps roles in sections.
Code standards
==============
How to write Ansible roles for DebOps.
Project roadmap
===============
Long term plans for DebOps.
Development model
=================
How DebOps is developed.
Monorepo layout
===============
How DebOps monorepo is structured.
Software sources
================
How DebOps handles external software.
......@@ -6,17 +6,89 @@
A collection of `Ansible <https://ansible.com/>`_ playbooks,
scalable from one container to an entire data center.
Contents:
.. note::
The DebOps documentation is currently being reorganized, some of the
sections might be empty or misleading. Ansible role documentation is
current for the roles in the `DebOps monorepo`_, the old project
documentation is available at the end of the ToC.
.. _DebOps monorepo: https://github.com/debops/debops/
.. toctree::
:caption: Introduction
:maxdepth: 1
introduction/quick-start
introduction/project-goals
introduction/faq
introduction/community
introduction/philosophy
introduction/timeline
.. toctree::
:caption: News
:maxdepth: 1
news/releases
news/changelog
news/upgrades
.. toctree::
:caption: User Guide
:maxdepth: 2
user-guide/install
user-guide/debops-for-ansible
user-guide/project-directories
user-guide/ansible-inventory
user-guide/site-playbook
user-guide/debops-cli
user-guide/debops-config
user-guide/bugs
.. toctree::
:caption: Ansible Roles
:hidden:
ansible/role-index
ansible/roles/index
.. toctree::
:caption: Developer Guide
:maxdepth: 2
developer-guide/development-model
developer-guide/monorepo-layout
developer-guide/code-standards
developer-guide/software-sources
developer-guide/debops-roadmap
.. toctree::
:caption: Tester Guide
:maxdepth: 2
tester-guide/test-methodology
tester-guide/travis-ci
tester-guide/gitlab-ci
tester-guide/vagrant
tester-guide/jane
tester-guide/testinfra
.. toctree::
:caption: DebOps API
:maxdepth: 2
debops-api/index
.. toctree::
:caption: Old documentation
:maxdepth: 2
:glob:
debops-tools/index
debops-playbooks/index
debops-policy/index
ansible/roles/index
debops-api/index
philosophy
......
Community
=========
Description of DebOps community.
Frequently Asked Questions
==========================
List of FAQ entries.
This diff is collapsed.
Project goals
=============
Description of the project goals.
Quick Start
===========
Description of the quick start.
Timeline
========
Project timeline.
.. include:: ../../CHANGELOG.rst
DebOps releases
===============
Description of the release process.
Upgrade notes
=============
Documentation about significant changes between project releases.
GitLab CI tests
===============
How DebOps is tested on GitLab CI.
Jane documentation
==================
Information about Jane.
Test methodology
================
Describe how DebOps is tested.
Testinfra documentation
=======================
Information about testinfra usage.
Travis CI tests
===============
How DebOps is tested on Travis CI.
Vagrant documentation
=====================
Information about Vagrant usage in tests.
Ansible inventory
=================
Tips for Ansible inventories.
Reporting bugs
==============
How to report bugs in DebOps.
DebOps CLI
==========
Description of the debops commands.
Script configuration
====================
Description of ``debops.cfg`` configuration options.
DebOps for Ansible users
========================
What DebOps does differently than normal Ansible setups.
Installation
============
Description of the installation methods.
Project directories
===================
Description of project directories.
The Site playbook
=================
Description of main playbook.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment