diff --git a/README.md b/README.md index 6f41036..78266c5 100644 --- a/README.md +++ b/README.md @@ -29,9 +29,12 @@ you to enter the Git details into them. By having a **devops** definition as described here you can further automate the process - and have a roadmap to change tooling if circumstances change. -If you do not include the **.well-known/devops.json** file creation into -your Git repository creation process, maybe some of the concepts may -provoke some improvements into your current process. +Some automation to the process can be achieved by executing simple +scripts at the start of the project. + +If you decide that **.well-known/devops.json** is not for you +maybe some of the concepts may provoke some improvements into +your current process. ## What doesn't it do diff --git a/background.md b/background.md new file mode 100644 index 0000000..9cd5bac --- /dev/null +++ b/background.md @@ -0,0 +1,9 @@ + + + +```mermaid + +mindmaps + + +``` diff --git a/guide/install.md b/guide/install.md index 7da5665..7b7e51f 100644 --- a/guide/install.md +++ b/guide/install.md @@ -1,5 +1,8 @@ # Install +_Note_: This document is not about the installation of +**rediops**. + The **install** section of the **devops.json** is to enable the discovery of the functions to use when a install of the component is required. diff --git a/guide/sbom.md b/guide/sbom.md index 8fe2cc5..99a89a4 100644 --- a/guide/sbom.md +++ b/guide/sbom.md @@ -1,3 +1,4 @@ # Software Bill of Materials (SBOM) - +The **rediops** definition can help with documenting +your SBOM diff --git a/guide/tutorial/microservice.md b/guide/tutorial/microservice.md index 1ab4cec..6917d4e 100644 --- a/guide/tutorial/microservice.md +++ b/guide/tutorial/microservice.md @@ -2,5 +2,12 @@ This is a tutorial demonstrating the build and deploying a Microservice. +The process summary is: +```mermaid + +journey + title Microservice project + +``` diff --git a/guide/tutorial/staticweb.md b/guide/tutorial/staticweb.md index 91a3540..6b45eba 100644 --- a/guide/tutorial/staticweb.md +++ b/guide/tutorial/staticweb.md @@ -6,4 +6,6 @@ There are many commercial and open source tools that provide a similar capabilit and this is not intended to replace those tools if yo have them already in everyday use. +The process summary is: + diff --git a/guide/uninstall.md b/guide/uninstall.md index 0aa97d2..096a263 100644 --- a/guide/uninstall.md +++ b/guide/uninstall.md @@ -1,5 +1,8 @@ # Uninstall +_Note_: This document is not about the uninstall of +**rediops**. + The **uninstall** section of the **devops.json** is to enable the discovery of the functions to use when a decommisison of the component is required. diff --git a/specification/rediops.yaml b/specification/rediops.yaml deleted file mode 100644 index e2ca368..0000000 --- a/specification/rediops.yaml +++ /dev/null @@ -1 +0,0 @@ -ErrorInternal Server Error \ No newline at end of file