diff --git a/README.md b/README.md index 49f96fb..9058b98 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,6 @@ # 3 Musketeers
- **Test, build, and deploy your apps from anywhere, the same way!** @@ -10,7 +9,6 @@ [![Build Status][linkGitHubActionsProjectBadge]][linkGitHubActionsProject] [![Netlify Status][linkNetlifyProjectBadge]][linkNetlifyProject] [![License][linkLicenseBadge]][linkLicense] -
@@ -52,31 +50,7 @@ The 3 Musketeers is a pattern for developing software in a repeatable and consistent manner. It leverages Make as an orchestration tool to test, build, run, and deploy applications using Docker and Docker Compose. The Make and Docker/Compose commands for each application are maintained as part of the application’s source code and are invoked in the same way whether run locally or on a CI/CD server. - -```mermaid -graph LR - host["**Host** - Linux - MacOS - Windows - CI/CD - ..."] - make["**Make** - test - build - run - deploy - ..."] - host-->make - make-->docker["Docker - Compose"] - container(("    **Container(s)**     - Go - Python - PostgreSQL - ...")) - docker-->container -``` + ## Why? @@ -106,14 +80,7 @@ _The demo was generated with VHS using the 3 Musketeers ([source](demo))._ Let's print out `Hello, World!` in the terminal using the 3 Musketeers. The command `make echo` will be calling Docker to run the command `echo 'Hello, World!'` inside a container. - -```mermaid -graph LR - host[Host]-->make[make echo] - make-->docker["Docker"] - docker-->container(("echo 'Hello, World!' - (container)")) -``` + ### Prerequisites diff --git a/diagrams/generate.sh b/diagrams/generate.sh index 5ed2c3b..1d8d4b0 100755 --- a/diagrams/generate.sh +++ b/diagrams/generate.sh @@ -9,6 +9,6 @@ find *.mmd -type f \ -p /puppeteer-config.json \ -b transparent \ -i {}' -printf "Copy *.svg to docs/guide/assets" +printf "Copy *.svg to docs/guide/assets\n" rm -fr /docs/guide/assets/*.svg cp *.svg /opt/docs/guide/assets diff --git a/diagrams/overview.mmd b/diagrams/overview.mmd index d211fce..464dba4 100644 --- a/diagrams/overview.mmd +++ b/diagrams/overview.mmd @@ -12,8 +12,8 @@ graph LR deploy ...`"] host-->make - make-->docker[Docker - Compose] + make-->docker["`**Docker** + **Compose**`"] container(("`**Command**   (container)   Go diff --git a/diagrams/overview.mmd.svg b/diagrams/overview.mmd.svg index 6e68dda..be893f9 100644 --- a/diagrams/overview.mmd.svg +++ b/diagrams/overview.mmd.svg @@ -1,4 +1,5 @@ -
+

Host
Linux
MacOS
Windows
CI/CD
...

-

Make
test
build
run
deploy
...

Docker
Compose
+

Make
test
build
run
deploy
...

+

Docker
Compose

Command
  (container)  
Go
Python
PostgreSQL
...

\ No newline at end of file diff --git a/docs/guide/assets/overview.mmd.svg b/docs/guide/assets/overview.mmd.svg index 6e68dda..be893f9 100644 --- a/docs/guide/assets/overview.mmd.svg +++ b/docs/guide/assets/overview.mmd.svg @@ -1,4 +1,5 @@ -
+

Host
Linux
MacOS
Windows
CI/CD
...

-

Make
test
build
run
deploy
...

Docker
Compose
+

Make
test
build
run
deploy
...

+

Docker
Compose

Command
  (container)  
Go
Python
PostgreSQL
...

\ No newline at end of file