diff --git a/source/engine-guide/configuration/system-database/index.rst b/source/engine-guide/configuration/system-database/index.rst index 8aaacc56..bd77a81f 100644 --- a/source/engine-guide/configuration/system-database/index.rst +++ b/source/engine-guide/configuration/system-database/index.rst @@ -28,7 +28,7 @@ The following database management systems are supported, choose one: mssql oracle -Use the :ref:`setup-wizard` or the :ref:`engine-config-cli` to create the system +Use the :ref:`setup-wizard` or the :ref:`engine-cli` to create the system database. To run the Axon Ivy Engine with a system database, a :ref:`license ` is required. diff --git a/source/engine-guide/reference/engine-config-cli.rst b/source/engine-guide/reference/engine-cli/index.rst similarity index 83% rename from source/engine-guide/reference/engine-config-cli.rst rename to source/engine-guide/reference/engine-cli/index.rst index 413e6ac7..dad9a9b4 100644 --- a/source/engine-guide/reference/engine-config-cli.rst +++ b/source/engine-guide/reference/engine-cli/index.rst @@ -1,6 +1,6 @@ -.. _engine-config-cli: +.. _engine-cli: -EngineConfigCli +EngineCli =============== The console program is used to configure the Axon Ivy Engine, i.e., to configure, @@ -15,3 +15,10 @@ create or convert the system database. +----------------+------------------------------------------------------------------------+ | help | Get help to a specific command e.g., ``EngineConfigCli config-db help``| +----------------+------------------------------------------------------------------------+ + +The concrete commands and descriptions can be found in our manpages: + +.. toctree:: + :maxdepth: 1 + + manpages/EngineConfigCli diff --git a/source/engine-guide/reference/engine-cli/manpages/EngineConfigCli.rst b/source/engine-guide/reference/engine-cli/manpages/EngineConfigCli.rst new file mode 100644 index 00000000..de050345 --- /dev/null +++ b/source/engine-guide/reference/engine-cli/manpages/EngineConfigCli.rst @@ -0,0 +1,6 @@ +.. _engine-cli-manpages: + +EngineCli Manpages +====================== + +This is just an placeholder and will be replaced with the manpages. diff --git a/source/engine-guide/reference/index.rst b/source/engine-guide/reference/index.rst index 3d7e2ab2..ee0a7af7 100644 --- a/source/engine-guide/reference/index.rst +++ b/source/engine-guide/reference/index.rst @@ -5,7 +5,7 @@ Reference :maxdepth: 2 axonivy-engine/index - engine-config-cli + engine-cli/index setup-wizard migration-wizard engine-cockpit/index diff --git a/source/engine-guide/reference/setup-wizard.rst b/source/engine-guide/reference/setup-wizard.rst index 2ea17065..573a76c4 100644 --- a/source/engine-guide/reference/setup-wizard.rst +++ b/source/engine-guide/reference/setup-wizard.rst @@ -14,7 +14,7 @@ license and the creation of a system database. from the wizard to the :ref:`ivy-yaml` file. Advanced users might prefer to manually craft configurations in :ref:`ivy-yaml` and -use the :ref:`engine-config-cli` to roll out an Axon Ivy Engine into production. +use the :ref:`engine-cli` to roll out an Axon Ivy Engine into production. Configuration files make the installation process quickly reproducable in various environments such as dev, test and prod.