Skip to content

Latest commit

 

History

History
58 lines (44 loc) · 1.6 KB

index.rst

File metadata and controls

58 lines (44 loc) · 1.6 KB

Welcome to OCS-CI's documentation!

This is a documentation for the OCS-CI project. OCS-CI is a testing framework based on pytest to test Red Hat OCS features and functionality using AWS and other supported platforms.

.. toctree::
   :maxdepth: 2
   :caption: Package documentations:

   ocs_ci modules <apidoc/modules.rst>


.. toctree::
   :maxdepth: 2
   :caption: README files

   OCS-CI README <README.md>
   DOCUMENTATION README <docs/README.md>
   bin dir README<bin/README.md>
   conf dir README <conf/README.md>
   ocsci conf dir README <conf/ocsci/README.md>
   ocp version conf dir README <conf/ocp_version/README.md>
   ocs version conf dir README <conf/ocs_version/README.md>
   external dir README <external/README.md>
   pytest_customization dir README <ocs_ci/framework/pytest_customization/README.md>
   ocs-deployment dir README <ocs_ci/templates/ocs-deployment/README.md>
   fio dir README <ocs_ci/templates/workloads/fio/README.md>


.. toctree::
   :maxdepth: 2
   :caption: Contents:

   Code review and contribution <docs/code_review.md>
   Code guidelines <docs/coding_guidelines.md>
   Getting started <docs/getting_started.md>
   Usage<docs/usage.md>
   Upgrade <docs/upgrade.md>
   Results <docs/results.md>
   Writing tests <docs/writing_tests.md>
   Fixture usage <docs/fixture_usage.md>
   Debugging <docs/debugging.md>
   Unit tests <docs/unit_tests.md>
   Workarounds <docs/workarounds.md>
   docs/deployment_without_ocs.md


Indices and tables