From 5acb307743540b4b966e50b0afb0cc9e355cd57b Mon Sep 17 00:00:00 2001 From: Sebastian Gumprich Date: Thu, 10 Aug 2023 11:37:14 +0200 Subject: [PATCH] Update README.MD --- README.MD | 30 ++++++++++++++++++------------ 1 file changed, 18 insertions(+), 12 deletions(-) diff --git a/README.MD b/README.MD index 3b101f4..c9f980c 100644 --- a/README.MD +++ b/README.MD @@ -16,7 +16,7 @@ The DMC provides a Dockerfile template (from modular setup) that creates the Doc The DMC uses the wakemeops as base setup, for more information about wakemeops look at the [docs](https://docs.wakemeops.com/). -### Try +### Try it out For a quick overview and test of the DMC, we have created images based on the [minimal](examples/min_build.yaml) and [full](examples/full_build.yaml) examples that can be used directly. @@ -34,10 +34,14 @@ docker run ghcr.io/telekom-mms/dmc:full Setup plugins, services, tools, versions and configuration over file with yaml syntax. +Create a build.yaml: + ``` bash touch build.yaml ``` +Then fill it with the settings you need: + * [Image](docs/usage/setup_and_configuration/image.md) * [Base](docs/usage/setup_and_configuration/base.md) * [Tools](docs/usage/setup_and_configuration/tools.md) @@ -45,15 +49,24 @@ touch build.yaml * [Post Build Config](docs/usage/setup_and_configuration/post_build_config.md) * [Tool Config](docs/usage/setup_and_configuration/tool_config.md) +Take a look at the examples to see what's possible: + +## Examples + +Examples for the `build.yaml` could be found under [examples](examples): + +* [minimal](examples/min_build.yaml) +* [full](examples/full_build.yaml) + ### Build #### Dockerfile -To create the Dockerfile from Template you have simply to run the following steps. +To create the Dockerfile from Template you have to run the following steps. -1. create build.yaml with your needed settings -2. run the script `render.sh` -3. build Docker Image +1. Create `build.yaml` with your needed settings +2. Run the script `render.sh` +3. Build the Docker Image `render.sh` @@ -200,13 +213,6 @@ To support the migration we provide a script to migrate from the old .docker_bui sh migrate.sh . ``` -## Examples - -Examples for the `build.yaml` could be found under [examples](examples): - -* [minimal](examples/min_build.yaml) -* [full](examples/full_build.yaml) - ## Others Feedback, suggestions for improvement and expansion, and of course collaboration are expressly desired.