Skip to content

Commit

Permalink
fixing links and front-page
Browse files Browse the repository at this point in the history
  • Loading branch information
l-gorman committed May 3, 2022
1 parent 618ef10 commit c3be834
Show file tree
Hide file tree
Showing 5 changed files with 90 additions and 46 deletions.
6 changes: 5 additions & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

# -- Project information -----------------------------------------------------

project = 'RHoMIS 2.0'
project = 'RHoMIS'
copyright = '2021, Léo Gorman'
author = 'Léo Gorman'

Expand Down Expand Up @@ -56,6 +56,10 @@
#html_static_path = ['_static']
html_static_path = []

html_theme_options = {
'prev_next_buttons_location': 'both'
}



# Need to specify suffixes so it knows which files to look for
Expand Down
32 changes: 27 additions & 5 deletions index.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,35 @@
Welcome to the RHoMIS Guide
=======================================
The Rural Househol Multi-Indicator Survey (RHoMIS)
===================================================

.. note::
Want to begin start using RHoMIS, go right to the
`RHoMIS App <https://app.l-gorman.com>`_

RHoMIS was designed to improve the process of gathering
information from farming households in the rural developing world.
Household surveys are very widely carried out, but the
data is rarely comparable, and so the opportunities for
learning between individual projects are limited.
For these reasons, the tool balances standardisation with flexibility.

RHoMIS was also designed to reduce costs, time requirements,
and reporting burdens for those who carry out household surveys.
Internationally recognised indicators are used, and reflexive
learning since 2015 has led to a smooth and rapid questionnaire,
which gathers considerable detail in a relatively short amount of time.

The tool is designed to minimise the burden on the rural household,
to maximise the reliability of responses, and to improve consistency
between different studies.

Learn more about RHoMIS :ref:`here <overview>`

.. toctree::
:maxdepth: 3
:caption: Getting Started
:caption: First Steps

source/overview.rst
source/quickstart.rst
source/overview.rst

.. toctree::
:maxdepth: 3
Expand All @@ -30,7 +53,6 @@ Welcome to the RHoMIS Guide
:maxdepth: 3
:caption: Contrinuting to RhoMIS 2.0

source/technical-system-overview.rst
source/developer-guide.rst
source/survey-builder-dev.rst
source/analysis-scripts-dev.rst
Expand Down
36 changes: 35 additions & 1 deletion source/developer-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,41 @@ components generally work and how they interact with one another. It does not co
and contributions, nor does it cover the specifics of the source code. For a more in depth look at how to install,
test, and contribute, we recommend looking at the GitHub repositories for each of the individual components.

For a quick overview, To access the individual repositories and other essential information, please go to :ref:`important_links`
.. _important_links:

Important Links
-----------------------------------------------
Below we have links to the repositories of RHoMIS 2.0 components and the API documentation.
To learn more about how the whole system operates, please see the :ref:`developer_guide`

User Facing Links
************************************************

#. `ODK central server <https://central.rhomis.cgiar.org/#/login?next=%2F>`_: Go here to create projects, upload forms, and submit data. If you need to create an account please get in touch with Leo.
#. `Data application front-end <https://app.l-gorman.com/>`_: After you have created a form and uploaded some data, go here and create an account. Once you login, you can begin querying data (will likely still be errors!)
#. Here is the link to the `survey builder <https://rhomis-survey.stats4sdtest.online/login>`_. (**Unsure if ready to use**)

Documentation
************************************************

In addition to this documentation, which gives an overview of the RHoMIS system. Each of the individual repositories (see below)
have their own specific documentation. We also have documentation on how to use the APIs:

#. `Authentication API <https://rhomisauthapi.docs.apiary.io/#>`_
#. `Data querying API <https://rhomisdataapi.docs.apiary.io/#>`_

Code Repositories
************************************************

#. `API code <https://github.com/l-gorman/rhomis-api>`_
#. `Data explorer app <https://github.com/l-gorman/rhomis-data-app>`_
#. `RHoMIS R-package <https://github.com/l-gorman/rhomis-R-package>`_
#. `R scripts running on RHomIS server <https://github.com/l-gorman/rhomis-server-R-scripts>`_
#. `This documentation <https://github.com/l-gorman/rhomis-docs>`_
#. `RHoMIS diagrams <https://github.com/l-gorman/rhomis-diagrams>`_
#. `Authentication server <https://github.com/l-gorman/rhomis-diagrams>`_ (**private**)
#. `Bash scripts used to set up server <https://github.com/l-gorman/rhomis-server-setup>`_ (**private**)


Summary of the RHoMIS 2.0 System
-------------------------------------------
Expand Down
27 changes: 23 additions & 4 deletions source/overview.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,27 @@
Overview
===========================================
.. _overview:

What is RHoMIS?
===================================================

Module Library
#####################################

A library of modules

Survey Builder
#####################################

Data Management System
#####################################

Analysis Package
#####################################

Extendable System
#####################################



What is RHoMIS
--------------------------------------------
The Rural Household Multi-Indicator Survey (RHoMIS) has been
widely used since 2015. RHoMIS consists of a suite of tools designed to
collect harmonised and interoperable data on smallholder farmers. Since 2020, the
Expand Down
35 changes: 0 additions & 35 deletions source/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,38 +9,3 @@ update the documentation regularly. For now, we are using this guide to give all
RHoMIS 2.0 meetings.


.. _important_links:

Important Links
-----------------------------------------------
Below we have links to the repositories of RHoMIS 2.0 components and the API documentation.
To learn more about how the whole system operates, please see the :ref:`developer_guide`

User Facing Links
************************************************

#. `ODK central server <https://central.rhomis.cgiar.org/#/login?next=%2F>`_: Go here to create projects, upload forms, and submit data. If you need to create an account please get in touch with Leo.
#. `Data application front-end <https://app.l-gorman.com/>`_: After you have created a form and uploaded some data, go here and create an account. Once you login, you can begin querying data (will likely still be errors!)
#. Here is the link to the `survey builder <https://rhomis-survey.stats4sdtest.online/login>`_. (**Unsure if ready to use**)

Documentation
************************************************

In addition to this documentation, which gives an overview of the RHoMIS system. Each of the individual repositories (see below)
have their own specific documentation. We also have documentation on how to use the APIs:

#. `Authentication API <https://rhomisauthapi.docs.apiary.io/#>`_
#. `Data querying API <https://rhomisdataapi.docs.apiary.io/#>`_

Code Repositories
************************************************

#. `API code <https://github.com/l-gorman/rhomis-api>`_
#. `Data explorer app <https://github.com/l-gorman/rhomis-data-app>`_
#. `RHoMIS R-package <https://github.com/l-gorman/rhomis-R-package>`_
#. `R scripts running on RHomIS server <https://github.com/l-gorman/rhomis-server-R-scripts>`_
#. `This documentation <https://github.com/l-gorman/rhomis-docs>`_
#. `RHoMIS diagrams <https://github.com/l-gorman/rhomis-diagrams>`_
#. `Authentication server <https://github.com/l-gorman/rhomis-diagrams>`_ (**private**)
#. `Bash scripts used to set up server <https://github.com/l-gorman/rhomis-server-setup>`_ (**private**)

0 comments on commit c3be834

Please sign in to comment.