From ccadb5dd9c370970f079195ae07bcf27806bc1b6 Mon Sep 17 00:00:00 2001 From: Joey Hafner Date: Fri, 8 Jul 2022 15:05:18 -0700 Subject: [PATCH] Edit navigation code block formatting --- homelab/README.md | 42 +++++++++++++++++++++++++++++++++--------- 1 file changed, 33 insertions(+), 9 deletions(-) diff --git a/homelab/README.md b/homelab/README.md index 6a94e4da..210f8314 100644 --- a/homelab/README.md +++ b/homelab/README.md @@ -5,16 +5,40 @@ Monolithic repository for my homelab # Navigation This repo is (mostly) organized into the following structure: ```bash -/ # The root contains repository meta-information like .gitignore, .gitlab-ci.yml, .gitmodules, and README.md. - docs/ # The /docs directory is for all self-contained documentation that is not tied to a specific service. Service-specific documentation is contained in /$host/config/$service/README.md - img/ # supporting images for use in docs +/ +# The root contains repository meta-information like .gitignore, +# .gitlab-ci.yml, .gitmodules, and README.md. + docs/ + # The /docs directory is for all self-contained documentation + # that is not tied to a specific service. Service-specific documentation + # is contained in /$host/config/$service/README.md + img/ + # supporting images for use in docs - $host/ # There are separate directories for the details and configuration of each host. At the root of `/$host/` we have non-authoritative documentation and reference. This includes printouts of hardware configs (`inxi -b`), host-specific procedure docs, useful scripts, etc.. - config/ # Anything in the `/$host/config` directory is used as a source of truth from which hosts pull and apply the defined configuration. - $service/ # for Docker-enabled hosts each service stack will be configured within a directory - docker-compose.yml # all services (except minecraft, which needed a more modular system) use docker-compose.yml to define their stack configuration. - .env # contains environment variables to be used by multiple containers within a stack - README.md # if a service stack has documentation specific to itself, it will be contained within this file. This usually contains procedure for interacting with a container and system configuration changes that could not be tracked in code (e.g. /etc/fstab or crontab or /etc/docker/daemon.json) + $host/ + # There are separate directories for the details and configuration of + # each host. At the root of `/$host/` we have non-authoritative + # documentation and reference. This includes printouts of hardware + # configs (`inxi -b`), host-specific procedure docs, useful scripts, etc. + config/ + # Anything in the `/$host/config` directory is used as a source of + # truth from which hosts pull and apply the defined configuration. + $service/ + # for Docker-enabled hosts each service stack will be + # configured within a directory + docker-compose.yml + # all services (except minecraft, which needed a + # more modular system) use docker-compose.yml to + # define their stack configuration. + .env + # contains environment variables to be used by multiple + # containers within a stack + README.md + # if a service stack has documentation specific to itself, + # it will be contained within this file. This usually contains + # procedure for interacting with a container and system configuration + # changes that could not be tracked in code (e.g. /etc/fstab or + # crontab or /etc/docker/daemon.json) ``` # Getting an SSH Key