guides: deploy: mention the need to specify stdcm search env

And specify how to do so

Signed-off-by: Baptiste Prevot <[email protected]>

Author: Castavo

content/docs/guides/deploy/_index.en.md

@@ -12,4 +12,10 @@ We will cover how to deploy OSRD within the following setups:
  - [Using docker compose]({{< ref "/docs/guides/deploy/docker-compose" >}}) on a single node.
  - [Using helm]({{< ref "/docs/guides/deploy/docker-compose" >}}) on a kubernetes cluster.
 
-It is also possible to deploy each service of OSRD manually on a system, but we will not cover this topic within this guide.
+It is also possible to deploy each service of OSRD manually on a system, but we will not cover this topic within this guide.
+
+
+{{% alert title="NB" color="warning" %}}
+In order for the STDCM tool to function, you'll need to setup the STDCM Search Environment, a configuration stored in database.
+See the [dedicated page]({{< ref "/docs/guides/deploy/stdcm-search-env" >}}) for more information.
+{{% /alert %}}

content/docs/guides/deploy/_index.fr.md

@@ -12,4 +12,10 @@ Nous allons couvrir comment déployer OSRD dans les configurations suivantes :
 - [Utiliser docker compose]({{< ref "/docs/guides/deploy/docker-compose" >}}) sur un seul nœud.
 - [Utiliser helm]({{< ref "/docs/guides/deploy/docker-compose" >}}) sur un cluster kubernetes.
 
-Il est également possible de déployer manuellement chaque service d'OSRD sur un système, mais nous ne couvrirons pas ce sujet dans ce guide.
+Il est également possible de déployer manuellement chaque service d'OSRD sur un système, mais nous ne couvrirons pas ce sujet dans ce guide.
+
+
+{{% alert title="NB" color="warning" %}}
+Pour que l'outil STDCM fonctionne, il faut configurer l'environnement de recherche STDCM, une configuration stockée en base de données.
+Consultez la [page dédiée]({{< ref "/docs/guides/deploy/stdcm-search-env" >}}) pour plus d'informations.
+{{% /alert %}}

content/docs/guides/deploy/stdcm-search-env.en.md

@@ -0,0 +1,28 @@
+---
+title: STDCM search environment configuration
+linkTitle: STDCM search environment configuration
+weight: 10
+description: How to configure the STDCM search environment
+---
+
+In order for the STDCM tool to function, you'll need to setup the STDCM Search Environment, a configuration stored in database.
+
+The configurable fields are as such:
+```rust
+pub struct StdcmSearchEnvironment {
+    pub infra_id: i64,
+    pub electrical_profile_set_id: Option<i64>,
+    pub work_schedule_group_id: Option<i64>,
+    pub timetable_id: i64,
+    pub search_window_begin: NaiveDateTime,
+    pub search_window_end: NaiveDateTime,
+}
+```
+
+This configuration is queried by the frontend. 
+That way, the right objects and time bounds are used transparently by the user.
+
+In order to setup this config, you can either 
+* Use the provided REST API (see [the editoast openAPI]({{< ref "/docs/reference/apis/editoast#operations-tag-stdcm_search_environment" >}}) 
+in the stdcm_search_environment section)
+* Use the provided editoast cli (run `editoast stdcm-search-env help` for more information)

content/docs/guides/deploy/stdcm-search-env.fr.md

@@ -0,0 +1,28 @@
+---
+title: "Configuration de l'environnement de recherche STDCM"
+linkTitle: "Configuration de l'environnement de recherche STDCM"
+weight: 10
+description: Comment configurer l'environnement de recherche STDCM
+---
+
+Pour que l'outil STDCM fonctionne, il faut configurer l'environnement de recherche STDCM, une configuration stockée en base de données.
+
+Les champs configurables sont les suivants :
+```rust
+pub struct StdcmSearchEnvironment {
+    pub infra_id: i64,
+    pub electrical_profile_set_id: Option<i64>,
+    pub work_schedule_group_id: Option<i64>,
+    pub timetable_id: i64,
+    pub search_window_begin: NaiveDateTime,
+    pub search_window_end: NaiveDateTime,
+}
+```
+
+Cette configuration est récupérée par le frontend afin que les bons objets et bornes temporelles soient utilisés 
+de manière transparente par l'utilisateur.
+
+Pour configurer cette environnement, vous pouvez soit :
+* Utiliser l'API REST prévue à cet effet (voir [l'openAPI d'editoast]({{< ref "/docs/reference/apis/editoast#operations-tag-stdcm_search_environment" >}})
+dans la section stdcm_search_environment)
+* Utiliser le CLI editoast (exécutez `editoast stdcm-search-env help` pour plus d'informations)