From 3f9b3d39287663903d4c35cf087b15f7b07bf93e Mon Sep 17 00:00:00 2001 From: Raine Date: Thu, 26 Oct 2023 01:55:33 +0200 Subject: [PATCH] refactor: docs --- doc/{structure.md => repo-structure.md} | 5 ++++- doc/{add-server.md => server-addition.md} | 3 ++- doc/server-purpose-legend.md | 1 - 3 files changed, 6 insertions(+), 3 deletions(-) rename doc/{structure.md => repo-structure.md} (98%) rename doc/{add-server.md => server-addition.md} (96%) diff --git a/doc/structure.md b/doc/repo-structure.md similarity index 98% rename from doc/structure.md rename to doc/repo-structure.md index b59d6fd..059aba4 100644 --- a/doc/structure.md +++ b/doc/repo-structure.md @@ -1,13 +1,16 @@ This repo uses a certain structure and some procedures. # `/tools` + Almost everthing can be managed with tools in the `/tools` directory. This does *not* change config however it interacts with it. # `/servers/` + All static servers on the IXVD network get it's own folder in `/servers`. These folders must be derived from `/servers/skel` which is a skeleton directory with all default config. # `/skel` + All servers share the same skeleton. -This contains backup scripts, ssh config and all other boring stuff. \ No newline at end of file +This contains backup scripts, ssh config and all other boring stuff. diff --git a/doc/add-server.md b/doc/server-addition.md similarity index 96% rename from doc/add-server.md rename to doc/server-addition.md index a997e73..4343cfd 100644 --- a/doc/add-server.md +++ b/doc/server-addition.md @@ -8,4 +8,5 @@ git clone https://git.ixvd.net/ixvd/neb /tmp/neb cd /tmp/neb sh config.sh ``` -3. done. \ No newline at end of file + +3. done. diff --git a/doc/server-purpose-legend.md b/doc/server-purpose-legend.md index 3945f3b..c46d845 100644 --- a/doc/server-purpose-legend.md +++ b/doc/server-purpose-legend.md @@ -7,4 +7,3 @@ Server purpose legend: - mouse: experimental services* *: mouse may have lots of downtime and is not supposed to house any vital infra. -