diff --git a/readme.md b/readme.md index 8ef397b..9735e1f 100644 --- a/readme.md +++ b/readme.md @@ -5,7 +5,7 @@ from various contexts of CA, DNS, CI and OS / OCI. --- -## Why +## 1 Why Project workflows can occur in: * an online or offline context, dealing with custom CA & DNS servers @@ -17,11 +17,11 @@ What if there was a unified way to do so? --- -## How +## 2 How Picture it… -### Group environment variables +### 2.1 Group environment variables * numbered * Certificate Authority armored certificates @@ -37,12 +37,12 @@ Picture it… * SSH key & hosts for deployments * a standalone POSIX shell script payload -### Workflow files +### 2.2 Workflow files * calling the POSIX shell script payload as their very first step * using a unified YAML syntax made of actions implemented in Python -### Integration & Deployment +### 2.3 Integration & Deployment #### Shell @@ -53,7 +53,7 @@ Picture it… * [X] Operating System updating * [X] installing Git to clone * [X] this project - * [X] its parent framework + * [X] its parent project * [X] installing Python * [X] system environment * [X] virtual environment @@ -76,9 +76,9 @@ Picture it… --- -## What +## 3 What -### Features +### 3.1 Features Handle project workflows in a unified way: @@ -107,7 +107,7 @@ Handle project workflows in a unified way: | Rocky | ☑ 9 | ☑ 8 | | Ubuntu | ☑ Noble (24.04) | ☐ Jammy (22.04) | -### Environment variables +### 3.2 Environment variables | Variable | Description | Default | |:------------------|:-------------------------|:--------------------------------| @@ -134,7 +134,7 @@ Handle project workflows in a unified way: | SPCD_URL_ROCKY | Rocky repository URL | https://dl.rockylinux.org | | SPCD_URL_UBUNTU | Ubuntu repository URL | https://ubuntu.mirrors.ovh.net | -### Operating Systems containers +### 3.3 Operating Systems containers #### Latest @@ -166,15 +166,15 @@ Handle project workflows in a unified way: --- -## Who +## 4 Who ### Author -* [Marc Beninca](https://marc.beninca.link) +* [Marc Beninca](https://forge.rwx.work/marc.beninca) --- -## Where +## 5 Where ### Chat @@ -193,9 +193,9 @@ Handle project workflows in a unified way: --- -## When +## 6 When -### Tasks for a 1st stable release +### 6.1 Tasks for a 1st stable release #### Documentation @@ -265,7 +265,7 @@ Handle project workflows in a unified way: * try git repo url variable first for shunit * test -### Task stack +### 6.2 Task stack * automate versions fetching * gource, xvfb, xauth