Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prefactor: Small doc clean-up #6314

Merged
merged 4 commits into from
Jun 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,5 @@ This documentation contains guides and reference material on how to self host Co
Service Guides <services/0-index>
Backups and Disaster Recovery <backups_dr/1-index>
Security <security/1-security>
Supporting Your Users <support/1-index>
Reference Material <reference/0-index>
Changelog <changelog/index>
42 changes: 33 additions & 9 deletions docs/source/installation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,39 @@ Deploy CommCare HQ

This section has details on the following topics.

- How to deploy a CommCare HQ instance on one or more servers (also referred as install sometimes).
- Import data if you are migrating from another existing instance such as Dimagi's www.commcarehq.org or any other using :ref:`migrate-project`.
- A :ref:`go-live-checklist` and :ref:`basic QA tests<new-env-qa>` to make sure everything is working well before making your instance live to the public.


Once you have understood what deployment option is most suitable for you using :ref:`deployment-options` guide and have all the :ref:`prerequisites <hosting-prereqs>` to deploy you can go ahead and deploy CommCare HQ! You can follow one of the deployment guides below depending on the type of deployment option that's suitable for you.

1. :ref:`quick-install`: This tutorial helps you install CommCare HQ on a single machine with an install wizard. Most of the install is done automatically with configuration set to sensible defaults. This is useful to quickly get started, test or preview what's involved in a working CommCare HQ environment.
2. :ref:`cchq-manual-install`: This tutorial helps you install CommCare HQ on a single machine or a small cluster using :ref:`prereqs/7-commcare-cloud:CommCare Cloud Deployment Tool`, the command-line tool used to not only install CommCare HQ but also to manage a CommCare HQ instance through its entire life-cycle. This method gives you more visibility into installation process, more control and configuration options suitable to your own needs. This is the recommended way to setup a multi machine production grade CommCare HQ instance.
- How to deploy a CommCare HQ instance on one or more servers
(also referred as install sometimes).

- Import data if you are migrating from another existing instance such
as Dimagi's www.commcarehq.org or any other
using :ref:`migrate-project`.

- A :ref:`go-live-checklist` and :ref:`basic QA tests <new-env-qa>` to
make sure everything is working well before making your instance live
to the public.

Once you have understood what deployment option is most suitable for you
using :ref:`deployment-options` guide and have all
the :ref:`prerequisites <hosting-prereqs>` to deploy you can go ahead
and deploy CommCare HQ! You can follow one of the deployment guides
below depending on the type of deployment option that's suitable for
you.

1. :ref:`quick-install`: This tutorial helps you install CommCare HQ on
a single machine with an install wizard. Most of the install is done
automatically with configuration set to sensible defaults. This is
useful to quickly get started, test or preview what's involved in a
working CommCare HQ environment.

2. :ref:`cchq-manual-install`: This tutorial helps you install CommCare
HQ on a single machine or a small cluster
using :ref:`prereqs/7-commcare-cloud:CommCare Cloud Deployment Tool`,
the command-line tool used to not only install CommCare HQ but also
to manage a CommCare HQ instance through its entire life-cycle. This
method gives you more visibility into installation process, more
control and configuration options suitable to your own needs. This
is the recommended way to setup a multi machine production grade
CommCare HQ instance.


.. toctree::
Expand Down
11 changes: 5 additions & 6 deletions docs/source/reference/0-index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ Reference Annexure

This section contains reference sections for various topics related to hosting a CommCare HQ instance.

.. TODO:
* /reference/4-ansible-resources.rst
* /reference/5-inventory-file.rst
* /reference/7-log-files.rst

.. toctree::
:maxdepth: 4

Expand All @@ -11,10 +16,4 @@ This section contains reference sections for various topics related to hosting a
/reference/firefighting/index
/reference/howto/index
/reference/6-settings.rst
..
Todo - release once written /reference/4-ansible-resources.rst
..
Todo - release once written /reference/5-inventory-file.rst
..
Todo - release once written /reference/7-log-files.rst
/reference/commcare-ports.rst
1 change: 0 additions & 1 deletion docs/source/reference/howto/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ Below docs contain how to instructions for special operations.
.. toctree::
:maxdepth: 1

/reference/howto/transfer-domain
/reference/howto/white-label
/reference/howto/firewall
/reference/howto/new-machine
Expand Down
17 changes: 7 additions & 10 deletions docs/source/scaling/1-index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,15 @@ This section contains guides on how to test your CommCare HQ instance's performa
The hardware requirements required for instances under 15,000 mobile users is given at :ref:`prereqs/5-requirements:Hardware requirements and Deployment Options`. This section is intended to provide information on how to scale CommCare HQ for projects going beyond 15,000 mobile users.


.. TODO:
* /scaling/2-webworkers
* /scaling/3-postgres
* /scaling/4-redis
* /scaling/5-elasticsearch
* /scaling/6-sizing-buckets

.. toctree::
:maxdepth: 4

..
Todo - release once written /scaling/2-webworkers
..
Todo - release once written /scaling/3-postgres
..
Todo - release once written /scaling/4-redis
..
Todo - release once written /scaling/5-elasticsearch
..
Todo - release once written /scaling/6-sizing-buckets
/scaling/perfomance-test
/scaling/sizing
Loading