Documentation (#506)

Moved over from using rst to using markdown to work better on
github.
Added mkdocs for managing the documentation instead of sphinx.
Changed the documentation theme to material as it gave better
navigation options.
Updated all documentation with guides for several areas such
as installation and running tests.

Author: t-persson

.readthedocs.yaml

@@ -0,0 +1,10 @@
+version: 2
+formats: all
+mkdocs:
+  fail_on_warning: false
+  configuration: mkdocs.yml
+python:
+  install:
+    - requirements: docs/requirements.txt
+build:
+  os: "ubuntu-22.04"

AUTHORS.md

@@ -0,0 +1,21 @@
+<!---
+   Copyright Axis Communications AB
+   For a full list of individual contributors, please see the commit history.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+--->
+# Maintainers
+
+- Anders Josephson <anders.josephson@axis.com>
+- Fredrik Fristedt <fredrik.fristedt@axis.com>
+- Tobias Persson <tobias.persson@axis.com>

AUTHORS.rst

@@ -1,138 +1,57 @@
-.. image:: images/etos-logo.png
-  :width: 350
-  :alt: ETOS
+<!---
+   Copyright Axis Communications AB
+   For a full list of individual contributors, please see the commit history.
 
-.. image:: https://img.shields.io/badge/Stage-Sandbox-yellow.svg
-  :target: https://github.com/eiffel-community/community/blob/master/PROJECT_LIFECYCLE.md#stage-sandbox
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
 
-====
-ETOS
-====
+       http://www.apache.org/licenses/LICENSE-2.0
 
-ETOS (Eiffel Test Orchestration System) is a new test orchestration system which takes away control of how to run and what to run from the system itself and places it into the hands of the relevant engineers.
-
-The idea of having a system dictate what and how to run is finished. Let's bring back control to the testers.
-
-With ETOS we define how to run tests using recipes and we define what to run with collections of recipes.
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+--->
 
-.. list-table :: ETOS Roles
-   :widths: 25 25 25
-   :header-rows: 1
+<img src="./docs/images/etos-logo.png" alt="ETOS" width="350"/>
 
-   * - :ref:`test-engineer`
-     - :ref:`test-automation-engineer`
-     - :ref:`system-engineer`
-   * - Create collections
-     - Create recipes
-     - Deploy ETOS
-   * - Analyze results
-     - Create tests
-     - Infrastructure
-   * - What to run?
-     - How to run?
-     - Where to run?
+[![Sandbox badge](https://img.shields.io/badge/Stage-Sandbox-yellow)](https://github.com/eiffel-community/community/blob/master/PROJECT_LIFECYCLE.md#stage-sandbox)
 
-This means that only people who knows how and what to run decide these factors. ETOS will only receive the collection of recipes and execute it accordingly.
-You can also mix test suites. For instance, let's say you want to run a "go" unittest and a "python" function test in the same suite, that's easy to do; just add them to your collection.
+# ETOS
 
-This is the strength of ETOS. Relying on the humans to decide what to run, how to run and where to run.
-
-ETOS is a collection of multiple services working together. This repository is a facilitator of versioning, Helm charts and documentation.
-The services are located in these repositories.
+ETOS (Eiffel Test Orchestration System) is a new test orchestration system which takes away control of how to run and what to run from the system itself and places it into the hands of the relevant engineers.
 
-- :ref:`etos-client`
-- :ref:`etos-api`
-- :ref:`etos-suite-starter`
-- :ref:`etos-suite-runner`
-- :ref:`etos-test-runner`
-- :ref:`etos-environment-provider`
-- :ref:`etos-library`
-- :ref:`etos-test-runner-containers`
+The idea of having a system dictate what and how to run is finished. Let's bring back control to the testers.
 
+Please see the [documentation](./docs/index.md) for more information, tutorials and guides on how to use ETOS.
 
-Features
-========
+## Features
 
 - Generic test suite execution based solely on JSON.
 - Mix and match test suites, regardless of programming language.
 - Separation of concerns between testers, test automation engineers and system engineers.
 - Eiffel protocol implementation.
 
+## Support
 
-Installation
-============
-
-Requirements
-------------
-
-In order to install ETOS, you need to meet the following requirements.
-
-- An up and running kubernetes cluster (`<https://kubernetes.io/>`_)
-- Helm version 3.x installed (`<https://helm.sh/>`_)
-
-
-Installation Steps
-------------------
-
-1. First we need to add the Helm repository where the ETOS Helm charts are stored
-
-::
-
-    helm repo add Eiffel registry.nordix.org/eiffel
-
-2. Then simply install ETOS using Helm
-
-::
-
-    helm install <name of the ETOS deployments> eiffel/etos --namespace <your kubernetes namespace>
-
-Deployment Configuration
-------------------------
-
-Following the installation step will give you a default configured ETOS deployment. Chances are that the default deployment configuration of ETOS will not work for your Infrastructure.
-To tailor the deployment to your specific infrastructure you need to create a configuration file and tell Helm to use that file when installing ETOS.
-
-Here is an example of a standard ETOS configuration file that should get most configurations up and running.
-
-.. code-block:: yaml
-
-    global:
-      # This is the URL to the Eiffel Graphql API
-      graphqlServerUrl: http://eiffel-graphql-api.my.cluster-url.com
-      # This is the URL where the deployed ETOS Environment Provider will be available
-      environmentProviderUrl: http://environment-provider.my.cluster-url.com
-      # This is the URL where the deployed ETOS API will be available
-      etosApiUrl: http://etos-api.my.cluster-url.com
-
-    suite-starter:
-      rabbitMQ:
-        # this is the message queue where suite starter listens for Eiffel
-        queue_name: suite_starter.queue
-
-    # This is the configuration that should match your rabbitMQ deployment
-    # ETOS needs a rabbitMQ service to be able to subscribe and publish Eiffel events
-    rabbitmqHost: dev-rabbitmq.myhost.com
-    rabbitmqExchange: my.eiffel.exchange
-    rabbitmqPort: "5671"
-    rabbitmqVhost: myvhost
-    rabbitMQ:
-      username: rabbit_user
-      password: rabbit_password
+If you need help, please get in contact with us.
 
+For questions and discussions, please use the [discussions](https://github.com/eiffel-community/etos/discussions) on github.
+For bug reports and feature requests, please use the [issue tracker](https://github.com/eiffel-community/etos/issues)
 
-Contribute
-==========
+There is also a mailing list at: etos-maintainers@googlegroups.com
 
-| Please write issues in the relevant repositories for where you found the issue.
-| If you do not know which repository to write the issue for, feel free to write it here and it will be moved.
-| Documentation issues are reported here.
+## Code of Conduct and Contributing
+To get involved, please see [Code of Conduct](https://github.com/eiffel-community/.github/blob/master/CODE_OF_CONDUCT.md) and [contribution guidelines](https://github.com/eiffel-community/.github/blob/master/CONTRIBUTING.md).
 
-- Issue Tracker: https://github.com/eiffel-community/etos/issues
-- Source Code: https://github.com/eiffel-community/etos
+Note that these files are located in the .github repository. See [this](https://docs.github.com/en/github/building-a-strong-community/creating-a-default-community-health-file) page for further details regarding default community health files.
 
+## About this repository
+The contents of this repository are licensed under the [Apache License 2.0](./LICENSE).
 
-Support
-=======
+## About Eiffel
+This repository forms part of the Eiffel Community. Eiffel is a protocol for technology agnostic machine-to-machine communication in continuous integration and delivery pipelines, aimed at securing scalability, flexibility and traceability. Eiffel is based on the concept of decentralized real time messaging, both to drive the continuous integration and delivery system and to document it.
 
-If you are having issues, please let us know.
-There is a mailing list at: etos-maintainers@googlegroups.com or just write an Issue.
+Visit [Eiffel Community](https://eiffel-community.github.io) to get started and get involved.

README.md

@@ -0,0 +1,21 @@
+<!---
+   Copyright Axis Communications AB
+   For a full list of individual contributors, please see the commit history.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+--->
+# Maintainers
+
+- Anders Josephson <anders.josephson@axis.com>
+- Fredrik Fristedt <fredrik.fristedt@axis.com>
+- Tobias Persson <tobias.persson@axis.com>