Skip to content

Commit

Permalink
Update readme with symlink
Browse files Browse the repository at this point in the history
  • Loading branch information
minottic committed Jun 25, 2024
1 parent 7cb80ac commit c07f26d
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ To add a new service (see the [backend v4](./services/backend/services/v4/) for
2. name it as the service
3. create the `compose.yaml` file with the required dependencies (if any)
4. eventually, include any service in (2) and (3) which is specific to the service and not shared across the global setup
5. eventually, add additional configurable logic (e.g. [BE_VERSION dependency](./services/frontend/compose.yaml#L14) and [ELASTIC_ENABLED dependency](./services/backend/services/v4/compose.yaml)). Remember to add an empty `.compose.<FEATURE>.yaml` (e.g. [here](./services/backend/services/v4/.compose.elastic.yaml)) if the service supports on/off. This also include DEV configurations, e.g. [here](./services/searchapi/compose.dev.yaml)
5. eventually, add additional configurable logic (e.g. [BE_VERSION dependency](./services/frontend/compose.yaml#L14) and [ELASTIC_ENABLED dependency](./services/backend/services/v4/compose.yaml)). Remember to add a `.compose.<FEATURE>.yaml` symlink to [.empty.yaml](./services/.empty.yaml) (e.g. [here](./services/backend/services/v4/.compose.elastic.yaml)) if the service supports on/off. This also includes DEV configurations, e.g. [here](./services/searchapi/compose.dev.yaml)
6. eventually, add entrypoints for init logics, as described [here](#if-the-service-does-not-support-entrypoints-yet-one-needs-to)
7. eventually, add the platform field, as described [here](#supported-os-architectures)
8. eventually, create a `config` folder if it requires configuration
Expand Down

0 comments on commit c07f26d

Please sign in to comment.