Skip to content

Commit

Permalink
Configuration fields described in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Vítězslav Dvořák committed Dec 17, 2024
1 parent efc2060 commit 9df8e85
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
Binary file added docs/source/appconfigfieldseditor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
33 changes: 33 additions & 0 deletions docs/source/configuration.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
.. _configuration:

Configuration
=============

Each application in MultiFlexi defines its own configuration fields. This is of a specific type and has additional properties.

Configuration Fields
--------------------

- Configuration Field Type - one of the following:
- **Text**: A single line text input.
- **Number**: A numeric input.
- **Date**: A date input.
- **Email**: An email input.
- **Password**: A password input.
- **Checkbox**: A yes/no checkbox.
- **File**: A file upload input.
- **Directory**: A directory path input.
- Keyword - (capital letters)
- Default Value - (used unless otherwise specified)
- Configuration Field Description
- required yes/no

.. image:: appconfigfieldseditor.png
:alt: Configuration fields of an application in an editor


JSON Configuration
-----

To configure the MultiFlexi project, you can also create a configuration file (e.g., `config.yaml`) with the necessary fields. Below is an example configuration file:

0 comments on commit 9df8e85

Please sign in to comment.