Feature ETP-3879: Improve Task doc based on feedback#661
Feature ETP-3879: Improve Task doc based on feedback#661mapenglishservices wants to merge 3 commits into
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the Task/Maintenance developer guide documentation (EN/ES) to clarify Debezium/PostgreSQL prerequisites and RX service setup steps, incorporating operational warnings and improved references.
Changes:
- Expanded Debezium/PostgreSQL setup instructions with clearer connection guidance and restart warnings (EN/ES).
- Added operational admonitions around RX initialization, Kafka Connect readiness, and Tomcat/database update sequencing (EN/ES).
- Simplified
mkdocs.ymlsearch plugin configuration by removing several search options.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
mkdocs.yml |
Simplifies MkDocs search plugin configuration. |
docs/developer-guide/etendo-classic/bundles/platform/task.md |
Adds/clarifies Debezium + RX setup guidance, warnings, and fixes an outdated link. |
docs/es/developer-guide/etendo-classic/bundles/platform/task.md |
Spanish equivalent of the Task/Maintenance doc improvements, warnings, and link update. |
Comments suppressed due to low confidence (2)
docs/es/developer-guide/etendo-classic/bundles/platform/task.md:70
- En esta sección se alterna entre
gradle.propertiesyGradle.properties. Dado que el nombre real del archivo esgradle.propertiesy en Linux/macOS el case importa, estandarice agradle.properties(incluyendo el título del bloque de código) para evitar confusión.
1. Configure las siguientes variables en `Gradle.properties` para habilitar e iniciar los servicios requeridos:
```groovy title="Gradle.properties"
docker_com.etendoerp.etendorx=true
docs/developer-guide/etendo-classic/bundles/platform/task.md:70
- This section alternates between
gradle.propertiesandGradle.properties. Sincegradle.propertiesis the file name used throughout the docs and is case-sensitive on Linux/macOS, please standardize togradle.properties(including the code block title) to avoid confusion.
1. Configure the following variables in `Gradle.properties` to enable and start the required services:
```groovy title="Gradle.properties"
docker_com.etendoerp.etendorx=true
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Este comando llama a la REST API de Kafka Connect, que se ejecuta en el puerto 8083 dentro de la red Docker de forma predeterminada. Si Kafka Connect no ha terminado de iniciarse tras `resources.up`, el comando fallará. Espere hasta que todos los servicios Docker estén en estado healthy antes de ejecutarlo (puede verificarlo con `docker ps` o desde su panel de Docker). | ||
|
|
||
| Solo es necesario que Kafka Connect esté en estado healthy para este paso. Los demás servicios RX dockerizados (config, auth, DAS, edge) se inician automáticamente y no requieren ninguna configuración manual en el ERP en este momento — los configurará en la sección **Inicializar servicios RX** que se describe a continuación. |
There was a problem hiding this comment.
La nota indica "Espere hasta que todos los servicios Docker estén en estado healthy" pero luego aclara que solo Kafka Connect debe estar healthy para este paso. Haga la guía consistente (por ejemplo, esperar específicamente a Kafka Connect y sus dependencias) para que quede claro qué hay que verificar antes de ejecutar kafkaConnectSetup.
| Este comando llama a la REST API de Kafka Connect, que se ejecuta en el puerto 8083 dentro de la red Docker de forma predeterminada. Si Kafka Connect no ha terminado de iniciarse tras `resources.up`, el comando fallará. Espere hasta que todos los servicios Docker estén en estado healthy antes de ejecutarlo (puede verificarlo con `docker ps` o desde su panel de Docker). | |
| Solo es necesario que Kafka Connect esté en estado healthy para este paso. Los demás servicios RX dockerizados (config, auth, DAS, edge) se inician automáticamente y no requieren ninguna configuración manual en el ERP en este momento — los configurará en la sección **Inicializar servicios RX** que se describe a continuación. | |
| Este comando llama a la REST API de Kafka Connect, que se ejecuta en el puerto 8083 dentro de la red Docker de forma predeterminada. Si Kafka Connect no ha terminado de iniciarse tras `resources.up`, el comando fallará. Antes de ejecutarlo, espere a que Kafka Connect —y las dependencias necesarias para que su API REST esté disponible— esté en estado healthy (puede verificarlo con `docker ps` o desde su panel de Docker). | |
| Para este paso no es necesario esperar a que todos los servicios RX dockerizados estén healthy. Los demás servicios RX (config, auth, DAS, edge) se inician automáticamente y no requieren ninguna configuración manual en el ERP en este momento — los configurará en la sección **Inicializar servicios RX** que se describe a continuación. |
| This command calls the Kafka Connect REST API, which runs on port 8083 inside the Docker network by default. If Kafka Connect has not fully started after `resources.up`, the command will fail. Wait until all Docker services are healthy before running it (you can check with `docker ps` or your Docker dashboard). | ||
|
|
||
| Only Kafka Connect needs to be healthy for this step. The other dockerized RX services (config, auth, DAS, edge) start automatically and do not require any manual ERP configuration at this point — you will configure them in the **Initialize RX Services** section below. |
There was a problem hiding this comment.
The note says to "wait until all Docker services are healthy" but then immediately says only Kafka Connect needs to be healthy for this step. Please make the guidance consistent (e.g., wait specifically for Kafka Connect and its dependencies to be healthy) so readers know what to check before running kafkaConnectSetup.
| This command calls the Kafka Connect REST API, which runs on port 8083 inside the Docker network by default. If Kafka Connect has not fully started after `resources.up`, the command will fail. Wait until all Docker services are healthy before running it (you can check with `docker ps` or your Docker dashboard). | |
| Only Kafka Connect needs to be healthy for this step. The other dockerized RX services (config, auth, DAS, edge) start automatically and do not require any manual ERP configuration at this point — you will configure them in the **Initialize RX Services** section below. | |
| This command calls the Kafka Connect REST API, which runs on port 8083 inside the Docker network by default. If Kafka Connect has not fully started after `resources.up`, the command will fail. Wait until Kafka Connect and its required dependencies are healthy before running it (you can check with `docker ps` or your Docker dashboard). | |
| For this step, confirm that Kafka Connect is healthy and reachable. The other dockerized RX services (config, auth, DAS, edge) start automatically and do not require any manual ERP configuration at this point — you will configure them in the **Initialize RX Services** section below. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
Warning Git Police 👮One or more commit messages do not meet the required standards. Please correct them.
|
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
Warning Git Police 👮One or more commit messages do not meet the required standards. Please correct them.
|
No description provided.