From 8de31d8b79edce2867b5da8fa6b710337e92ec29 Mon Sep 17 00:00:00 2001 From: Sheogorath <sheogorath@shivering-isles.com> Date: Sat, 25 Jun 2022 06:37:55 +0200 Subject: [PATCH] docs: Add documentation for images and overall sections --- docs/src/SUMMARY.md | 12 ++++++++---- docs/src/charts/README.md | 3 +++ docs/src/images/README.md | 3 +++ docs/src/images/demo.md | 1 + docs/src/images/dovecot.md | 1 + docs/src/images/koolbox.md | 1 + docs/src/images/postfix.md | 1 + images/demo/README.md | 3 +++ 8 files changed, 21 insertions(+), 4 deletions(-) create mode 100644 docs/src/charts/README.md create mode 100644 docs/src/images/README.md create mode 120000 docs/src/images/demo.md create mode 120000 docs/src/images/dovecot.md create mode 120000 docs/src/images/koolbox.md create mode 120000 docs/src/images/postfix.md create mode 100644 images/demo/README.md diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 883a8c534..40a020217 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -6,7 +6,7 @@ - [Hardware]() - [Operating System](operating_system.md) - [Network]() -- [Continous Integreation]() +- [Continuous Integration]() - [GitOps]() - [Infrastructure Components](components/README.md) - [calico](components/calico.md) @@ -27,9 +27,13 @@ - [Matrix]() - [Nextcloud]() - [Registry]() - -# Helm Charts -- [MoK](charts/mok.md) +- [Helm Charts](charts/README.md) + - [MoK](charts/mok.md) +- [Images](images/README.md) + - [Demo](images/demo.md) + - [Dovecot](images/dovecot.md) + - [Koolbox](images/koolbox.md) + - [Postfix](images/postfix.md) --- diff --git a/docs/src/charts/README.md b/docs/src/charts/README.md new file mode 100644 index 000000000..6f9a52f74 --- /dev/null +++ b/docs/src/charts/README.md @@ -0,0 +1,3 @@ +# Helm Charts + +Various helm charts maintained as part of the Shivering-Isles GitOps monorepo. diff --git a/docs/src/images/README.md b/docs/src/images/README.md new file mode 100644 index 000000000..813467431 --- /dev/null +++ b/docs/src/images/README.md @@ -0,0 +1,3 @@ +# Images + +Overview over images that are maintained as part of the GitOps infrastructure repository. diff --git a/docs/src/images/demo.md b/docs/src/images/demo.md new file mode 120000 index 000000000..e4dd80b16 --- /dev/null +++ b/docs/src/images/demo.md @@ -0,0 +1 @@ +../../../images/demo/README.md \ No newline at end of file diff --git a/docs/src/images/dovecot.md b/docs/src/images/dovecot.md new file mode 120000 index 000000000..98f77696e --- /dev/null +++ b/docs/src/images/dovecot.md @@ -0,0 +1 @@ +../../../images/dovecot/README.md \ No newline at end of file diff --git a/docs/src/images/koolbox.md b/docs/src/images/koolbox.md new file mode 120000 index 000000000..59567d036 --- /dev/null +++ b/docs/src/images/koolbox.md @@ -0,0 +1 @@ +../../../cli/README.md \ No newline at end of file diff --git a/docs/src/images/postfix.md b/docs/src/images/postfix.md new file mode 120000 index 000000000..d5bf70d46 --- /dev/null +++ b/docs/src/images/postfix.md @@ -0,0 +1 @@ +../../../images/postfix/README.md \ No newline at end of file diff --git a/images/demo/README.md b/images/demo/README.md new file mode 100644 index 000000000..d88b2733e --- /dev/null +++ b/images/demo/README.md @@ -0,0 +1,3 @@ +# Demo + +Demo image mainly to test and showcase the Makefile integration. -- GitLab