.. _contents:

=======================
Developer Documentation
=======================

These pages contain the developer documentation. They are aimed at those who are modifying the
source code of the project.

Contents:
---------

.. toctree::
   :maxdepth: 1


   contributing
   containerization
   env_variables
   external_service_dependencies
   localenv
   usecases/index
   devops/index
   devops/gitlab_ci_jobs
   walkthroughs/index
   troubleshoot/index
   job_control_layer
   modules/index

Development of the application is carried out by building and testing
the software in three different environments:

- :ref:`locally <local environment>` at the developer's workstation.
- at :ref:`GitLab CI <Gitlab Ci Job Descriptions>` for automated testing.
- remotely at server `reflectivity-test.ornl.gov` for manual testing,
  termed environment `testenv`.

.. image:: /developer/images/devops_1.png
    :width: 800px
    :align: center
    :alt: continuous integration cycle

In all cases, building is implemented with :ref:`containerization <containerization>`
of the application in concert with
:ref:`additional containers and services <External Service Dependencies>`
providing the necessary services to successfully run the application, such as a database.