Migrate documentation from rst to MyST (#51)

* Migrate documentation from rst to MyST

* fix badge path

Author: theCapypara

.github/workflows/build-docs.yml

@@ -23,6 +23,8 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: 3.12
+      - name: Remove old docs
+        run: rm -rf ./docs/source/repo_docs
       - name: Build docs
         run: ./copy_docs.py ./docs/source/repo_docs
       - name: Create Pull Request

README.md

@@ -0,0 +1,64 @@
+# ![Riptide](https://riptide-docs.readthedocs.io/en/latest/_images/logo.png)
+
+[<img src="https://readthedocs.org/projects/riptide-docs/badge/?version=latest" alt="Documentation Status">](https://riptide-docs.readthedocs.io/en/latest/)
+
+Riptide is a set of tools to manage development environments for web applications.
+It's using container virtualization tools, such as [Docker](https://www.docker.com/)
+to run all services needed for a project.
+
+It's goal is to be easy to use by developers.
+Riptide abstracts the virtualization in such a way that the environment behaves exactly
+as if you were running it natively, without the need to install any other requirements
+the project may have.
+
+Riptide consists of a few reposiories, find the entire [overview](https://riptide-docs.readthedocs.io/en/latest/development.html) in the documentation.
+
+## Riptide Repository
+
+This repository contains services, commands and apps that can be used in Riptide projects.
+
+The master branch contains the up-to-date versions for all objects, branches for certain
+Riptide versions may exist (eg. 0.1 for version 0.1).
+
+The apps, services and commands contain their own README files with more information.
+Browse the `app`, `service` and `command` directories to find objects you may
+find useful for your projects.
+
+This is the public community repository for Riptide. Please feel free to contribute!
+
+## Contributing
+
+If you want to submit your own apps, services and or commands, open a pull request. Your
+objects need to be valid for the newest Riptide version, or,if you are opening a pull
+request for older versions, with the respective version. Automatic tests will check basic
+functionality for your objects.
+
+You need to provide an up-to-date documentation for your object, in form of a README.rst. Templates
+can be found in the \_contrib-templates directory.
+
+### Submission guidelines
+
+- Images should be either:
+
+  - official (marked as "Official Image" in the Docker hub),
+  - from the "[riptidepy](https://hub.docker.com/u/riptidepy)" org on Docker Hub (see [docker_images]).
+  - or very well maintained, open source and trusted (eg. high amount of stars on Github)
+
+- When using variables, do not reference fields that contain other variables (expect
+  in `<Service>.notices`).
+
+- When using the variable helper function `parent()`, do not reference fields that
+  contain other variables.
+
+- `do_not_create_user` must not be `True` for services.
+
+- Standalone services must not have any roles set (except for `db`).
+
+More Guidelines may be added.
+
+## Documentation
+
+Documentation for apps, services and commands can be found inside the directories
+of this repository.
+
+The complete documentation for Riptide can be found at [Read the Docs](https://riptide-docs.readthedocs.io/en/latest/).

README.rst

@@ -0,0 +1,54 @@
+# NAME_OF_THE_APP
+
+% General description of the app
+
+
+## `/app/PATH/PATH`
+
+% If this app is based on some other entity:
+
+**Based on**: [/app/xyz](https://github.com/Parakoopa/riptide-repo/tree/master/app/xyz)
+
+% Description of this version of the app, with the most important things to note
+
+% Now follow descriptions of certain properties of this entity.
+
+% If some properties are inherited, you only need to describe what was changed
+
+% (=> what is actually contained in your yaml document)
+
+% Properties that don't apply can be left out
+
+### Imports
+
+| Key     | Title          | Target    | Description                  |
+| ------- | -------------- | --------- | ---------------------------- |
+| example | Example Import | files/pub | A description of this import |
+|         |                |           |                              |
+|         |                |           |                              |
+
+### Services
+
+#### SERVICE
+
+% see contents of README_service.rst (starting at ``/service/PATH/PATH``)
+
+% "Suggested Roles" should be called "Roles" instead.
+
+##### Role Requirements
+
+### Commands
+
+#### COMMAND
+
+% see contents of README_command.rst (starting at ``/command/PATH/PATH``)
+
+##### Role Requirements
+
+## `/app/PATH/PATH2`
+
+% other variants, see above.
+
+## `/app/PATH/PATH3`, `/app/PATH/PATH4`
+
+% if variants are very similar, you can group them

_contrib-templates/README_app.md

@@ -0,0 +1,56 @@
+# NAME_OF_THE_COMMAND
+
+% General description of the command
+
+
+## `/command/PATH/PATH`
+
+% If this service is based on some other entity:
+
+**Based on**: [/command/xyz](https://github.com/Parakoopa/riptide-repo/tree/master/command/xyz)
+
+% Description of this version of the command, with the most important things to note
+
+% Now follow descriptions of certain properties of this entity.
+
+% If some properties are inherited, you only need to describe what was changed
+
+% (=> what is actually contained in your yaml document)
+
+% Properties that don't apply can be left out
+
+### Role Requirements
+
+**Role**: `xyz`
+
+This command requires another service that has the role `xyz` set.
+
+% Describe the requirements this other service needs to have and explain
+
+% what this service is used for
+
+### Environment variables
+
+| Key         | Required? | Already set?       | Example Value(s) | Description                                                                       |
+| ----------- | --------- | ------------------ | ---------------- | --------------------------------------------------------------------------------- |
+| HELLO_WORLD | yes       | yes (default: XYZ) | XYZ, ABC         | Description of a setting environment value. Already set values should come first. |
+| FOO_BAR     | no        | no                 | FOO, BAR         | Description 2                                                                     |
+|             |           |                    |                  |                                                                                   |
+
+### Additional volumes
+
+| Name               | Source                      | Source path                                 | Target path | Description |
+| ------------------ | --------------------------- | ------------------------------------------- | ----------- | ----------- |
+| as_in_config_entry | Home directory              | ~/.npm                                      | ~/.npm      | Description |
+|                    | Data folder                 | \_riptide/data/\_\_\_/name                  |             |             |
+|                    | Part of source code         | src/foo                                     |             |             |
+|                    | Config from another service | (config 'xyz' from service with role 'abc') |             |             |
+|                    | Other                       | /hardcoded/path                             |             |             |
+
+## `/command/PATH/PATH2`
+
+% other variants, see above.
+
+## `/command/PATH/PATH3`, `/command/PATH/PATH4`
+
+% if variants are very similar, you can group them