chore: move docs source to docs-src (#1671)

ferrarimarco · Oct 26, 2024 · 4d54f4c · 4d54f4c
1 parent d0f2531
commit 4d54f4c
Show file tree

Hide file tree

Showing 87 changed files with 23 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -2,4 +2,4 @@
 
 For more information about how to set up the lab, see
 [the webesite](https://ferrarimarco.github.io/home-lab)
-or the contents of the [docs directory](./docs/README.md).
+or the contents of the [docs directory](./docs-src/README.md).
diff --git a/config/lint/.jscpd.json b/config/lint/.jscpd.json
@@ -5,7 +5,7 @@
     "**/.esphome/**",
     "**/.venv*/**",
     "**/grafana/dashboards/dashboard-definitions/**/*.json",
-    "**/site/**",
+    "**/docs/**",
     "**/user-data*.yaml"
   ],
   "absolute": true,

diff --git a/config/lint/super-linter.env b/config/lint/super-linter.env
@@ -1,6 +1,6 @@
 ANSIBLE_DIRECTORY=docker/ansible/etc/ansible
 CREATE_LOG_FILE=true
-FILTER_REGEX_EXCLUDE=(^|/)site/
+FILTER_REGEX_EXCLUDE=(^|/)docs/
 GITLEAKS_LOG_LEVEL=warn
 IGNORE_GITIGNORED_FILES=true
 LINTER_RULES_PATH=config/lint

diff --git a/config/mkdocs/home-lab-docs/mkdocs.yaml b/config/mkdocs/home-lab-docs/mkdocs.yaml
@@ -1,8 +1,8 @@
 ---
 # yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
-docs_dir: "../../../docs"
+docs_dir: "../../../docs-src"
 repo_url: https://github.com/ferrarimarco/home-lab
-site_dir: "../../../site"
+site_dir: "../../../docs"
 site_name: Home Lab docs
 site_url: https://ferrarimarco.github.io/home-lab
 strict: true

diff --git a/config/pre-commit/.pre-commit-config.yaml b/config/pre-commit/.pre-commit-config.yaml
@@ -2,7 +2,7 @@
 # yaml-language-server: $schema=https://json.schemastore.org/pre-commit-config.json
 exclude: |
   (?x)^(
-      site/.*|\.venv/.*
+      docs/.*|\.venv/.*
   )$
 fail_fast: true
 repos:

diff --git a/docs/README.md → docs-src/README.md b/docs/README.md → docs-src/README.md
diff --git a/docs/architecture/README.md → docs-src/architecture/README.md b/docs/architecture/README.md → docs-src/architecture/README.md
diff --git a/...chitecture/dns-zones-servers-resolvers.md → ...chitecture/dns-zones-servers-resolvers.md b/...chitecture/dns-zones-servers-resolvers.md → ...chitecture/dns-zones-servers-resolvers.md
diff --git a/docs/architecture/network-subnets.md → docs-src/architecture/network-subnets.md b/docs/architecture/network-subnets.md → docs-src/architecture/network-subnets.md
diff --git a/docs/architecture/references.md → docs-src/architecture/references.md b/docs/architecture/references.md → docs-src/architecture/references.md
diff --git a/...des/capture-proxmox-vm-network-traffic.md → ...des/capture-proxmox-vm-network-traffic.md b/...des/capture-proxmox-vm-network-traffic.md → ...des/capture-proxmox-vm-network-traffic.md
diff --git a/docs/guides/configure-monitoring.md → docs-src/guides/configure-monitoring.md b/docs/guides/configure-monitoring.md → docs-src/guides/configure-monitoring.md
diff --git a/docs/guides/configure-network-shares.md → docs-src/guides/configure-network-shares.md b/docs/guides/configure-network-shares.md → docs-src/guides/configure-network-shares.md
diff --git a/docs/guides/configure-tailscale.md → docs-src/guides/configure-tailscale.md b/docs/guides/configure-tailscale.md → docs-src/guides/configure-tailscale.md
diff --git a/docs/guides/container-migration.md → docs-src/guides/container-migration.md b/docs/guides/container-migration.md → docs-src/guides/container-migration.md
diff --git a/docs/guides/copy-jinja-templates.md → docs-src/guides/copy-jinja-templates.md b/docs/guides/copy-jinja-templates.md → docs-src/guides/copy-jinja-templates.md
diff --git a/docs/guides/expand-partition-debian.md → docs-src/guides/expand-partition-debian.md b/docs/guides/expand-partition-debian.md → docs-src/guides/expand-partition-debian.md
diff --git a/docs/guides/linux-disk-setup.md → docs-src/guides/linux-disk-setup.md b/docs/guides/linux-disk-setup.md → docs-src/guides/linux-disk-setup.md
diff --git a/docs/guides/useful-linux-admin-commands.md → ...src/guides/useful-linux-admin-commands.md b/docs/guides/useful-linux-admin-commands.md → ...src/guides/useful-linux-admin-commands.md
diff --git a/docs/guides/useful-proxmox-commands.md → docs-src/guides/useful-proxmox-commands.md b/docs/guides/useful-proxmox-commands.md → docs-src/guides/useful-proxmox-commands.md
diff --git a/docs/installation/production/README.md → docs-src/installation/production/README.md b/docs/installation/production/README.md → docs-src/installation/production/README.md
diff --git a/...llation/production/provision-new-hosts.md → ...llation/production/provision-new-hosts.md b/...llation/production/provision-new-hosts.md → ...llation/production/provision-new-hosts.md
diff --git a/site/404.html → docs/404.html b/site/404.html → docs/404.html
diff --git a/...re/dns-zones-servers-resolvers/index.html → ...re/dns-zones-servers-resolvers/index.html b/...re/dns-zones-servers-resolvers/index.html → ...re/dns-zones-servers-resolvers/index.html
diff --git a/site/architecture/index.html → docs/architecture/index.html b/site/architecture/index.html → docs/architecture/index.html
diff --git a/site/architecture/network-subnets/index.html → docs/architecture/network-subnets/index.html b/site/architecture/network-subnets/index.html → docs/architecture/network-subnets/index.html
diff --git a/site/architecture/references/index.html → docs/architecture/references/index.html b/site/architecture/references/index.html → docs/architecture/references/index.html
diff --git a/site/assets/images/favicon.png → docs/assets/images/favicon.png b/site/assets/images/favicon.png → docs/assets/images/favicon.png
diff --git a/...assets/javascripts/bundle.83f73b43.min.js → ...assets/javascripts/bundle.83f73b43.min.js b/...assets/javascripts/bundle.83f73b43.min.js → ...assets/javascripts/bundle.83f73b43.min.js
diff --git a/...ts/javascripts/bundle.83f73b43.min.js.map → ...ts/javascripts/bundle.83f73b43.min.js.map b/...ts/javascripts/bundle.83f73b43.min.js.map → ...ts/javascripts/bundle.83f73b43.min.js.map
diff --git a/...ssets/javascripts/lunr/min/lunr.ar.min.js → ...ssets/javascripts/lunr/min/lunr.ar.min.js b/...ssets/javascripts/lunr/min/lunr.ar.min.js → ...ssets/javascripts/lunr/min/lunr.ar.min.js
diff --git a/...ssets/javascripts/lunr/min/lunr.da.min.js → ...ssets/javascripts/lunr/min/lunr.da.min.js b/...ssets/javascripts/lunr/min/lunr.da.min.js → ...ssets/javascripts/lunr/min/lunr.da.min.js
diff --git a/...ssets/javascripts/lunr/min/lunr.de.min.js → ...ssets/javascripts/lunr/min/lunr.de.min.js b/...ssets/javascripts/lunr/min/lunr.de.min.js → ...ssets/javascripts/lunr/min/lunr.de.min.js
diff --git a/...ssets/javascripts/lunr/min/lunr.du.min.js → ...ssets/javascripts/lunr/min/lunr.du.min.js b/...ssets/javascripts/lunr/min/lunr.du.min.js → ...ssets/javascripts/lunr/min/lunr.du.min.js
diff --git a/...ssets/javascripts/lunr/min/lunr.el.min.js → ...ssets/javascripts/lunr/min/lunr.el.min.js b/...ssets/javascripts/lunr/min/lunr.el.min.js → ...ssets/javascripts/lunr/min/lunr.el.min.js
diff --git a/...ssets/javascripts/lunr/min/lunr.es.min.js → ...ssets/javascripts/lunr/min/lunr.es.min.js b/...ssets/javascripts/lunr/min/lunr.es.min.js → ...ssets/javascripts/lunr/min/lunr.es.min.js
diff --git a/...ssets/javascripts/lunr/min/lunr.fi.min.js → ...ssets/javascripts/lunr/min/lunr.fi.min.js b/...ssets/javascripts/lunr/min/lunr.fi.min.js → ...ssets/javascripts/lunr/min/lunr.fi.min.js
diff --git a/...ssets/javascripts/lunr/min/lunr.fr.min.js → ...ssets/javascripts/lunr/min/lunr.fr.min.js b/...ssets/javascripts/lunr/min/lunr.fr.min.js → ...ssets/javascripts/lunr/min/lunr.fr.min.js
diff --git a/...ssets/javascripts/lunr/min/lunr.he.min.js → ...ssets/javascripts/lunr/min/lunr.he.min.js b/...ssets/javascripts/lunr/min/lunr.he.min.js → ...ssets/javascripts/lunr/min/lunr.he.min.js
diff --git a/...ssets/javascripts/lunr/min/lunr.hi.min.js → ...ssets/javascripts/lunr/min/lunr.hi.min.js b/...ssets/javascripts/lunr/min/lunr.hi.min.js → ...ssets/javascripts/lunr/min/lunr.hi.min.js
diff --git a/...ssets/javascripts/lunr/min/lunr.hu.min.js → ...ssets/javascripts/lunr/min/lunr.hu.min.js b/...ssets/javascripts/lunr/min/lunr.hu.min.js → ...ssets/javascripts/lunr/min/lunr.hu.min.js
diff --git a/...ssets/javascripts/lunr/min/lunr.hy.min.js → ...ssets/javascripts/lunr/min/lunr.hy.min.js b/...ssets/javascripts/lunr/min/lunr.hy.min.js → ...ssets/javascripts/lunr/min/lunr.hy.min.js
diff --git a/...ssets/javascripts/lunr/min/lunr.it.min.js → ...ssets/javascripts/lunr/min/lunr.it.min.js b/...ssets/javascripts/lunr/min/lunr.it.min.js → ...ssets/javascripts/lunr/min/lunr.it.min.js
diff --git a/...ssets/javascripts/lunr/min/lunr.ja.min.js → ...ssets/javascripts/lunr/min/lunr.ja.min.js b/...ssets/javascripts/lunr/min/lunr.ja.min.js → ...ssets/javascripts/lunr/min/lunr.ja.min.js
diff --git a/...ssets/javascripts/lunr/min/lunr.jp.min.js → ...ssets/javascripts/lunr/min/lunr.jp.min.js b/...ssets/javascripts/lunr/min/lunr.jp.min.js → ...ssets/javascripts/lunr/min/lunr.jp.min.js
diff --git a/...ssets/javascripts/lunr/min/lunr.kn.min.js → ...ssets/javascripts/lunr/min/lunr.kn.min.js b/...ssets/javascripts/lunr/min/lunr.kn.min.js → ...ssets/javascripts/lunr/min/lunr.kn.min.js
diff --git a/...ssets/javascripts/lunr/min/lunr.ko.min.js → ...ssets/javascripts/lunr/min/lunr.ko.min.js b/...ssets/javascripts/lunr/min/lunr.ko.min.js → ...ssets/javascripts/lunr/min/lunr.ko.min.js
diff --git a/...ts/javascripts/lunr/min/lunr.multi.min.js → ...ts/javascripts/lunr/min/lunr.multi.min.js b/...ts/javascripts/lunr/min/lunr.multi.min.js → ...ts/javascripts/lunr/min/lunr.multi.min.js
diff --git a/...ssets/javascripts/lunr/min/lunr.nl.min.js → ...ssets/javascripts/lunr/min/lunr.nl.min.js b/...ssets/javascripts/lunr/min/lunr.nl.min.js → ...ssets/javascripts/lunr/min/lunr.nl.min.js
diff --git a/...ssets/javascripts/lunr/min/lunr.no.min.js → ...ssets/javascripts/lunr/min/lunr.no.min.js b/...ssets/javascripts/lunr/min/lunr.no.min.js → ...ssets/javascripts/lunr/min/lunr.no.min.js
diff --git a/...ssets/javascripts/lunr/min/lunr.pt.min.js → ...ssets/javascripts/lunr/min/lunr.pt.min.js b/...ssets/javascripts/lunr/min/lunr.pt.min.js → ...ssets/javascripts/lunr/min/lunr.pt.min.js
diff --git a/...ssets/javascripts/lunr/min/lunr.ro.min.js → ...ssets/javascripts/lunr/min/lunr.ro.min.js b/...ssets/javascripts/lunr/min/lunr.ro.min.js → ...ssets/javascripts/lunr/min/lunr.ro.min.js
diff --git a/...ssets/javascripts/lunr/min/lunr.ru.min.js → ...ssets/javascripts/lunr/min/lunr.ru.min.js b/...ssets/javascripts/lunr/min/lunr.ru.min.js → ...ssets/javascripts/lunr/min/lunr.ru.min.js
diff --git a/...ssets/javascripts/lunr/min/lunr.sa.min.js → ...ssets/javascripts/lunr/min/lunr.sa.min.js b/...ssets/javascripts/lunr/min/lunr.sa.min.js → ...ssets/javascripts/lunr/min/lunr.sa.min.js
diff --git a/...ipts/lunr/min/lunr.stemmer.support.min.js → ...ipts/lunr/min/lunr.stemmer.support.min.js b/...ipts/lunr/min/lunr.stemmer.support.min.js → ...ipts/lunr/min/lunr.stemmer.support.min.js
diff --git a/...ssets/javascripts/lunr/min/lunr.sv.min.js → ...ssets/javascripts/lunr/min/lunr.sv.min.js b/...ssets/javascripts/lunr/min/lunr.sv.min.js → ...ssets/javascripts/lunr/min/lunr.sv.min.js
diff --git a/...ssets/javascripts/lunr/min/lunr.ta.min.js → ...ssets/javascripts/lunr/min/lunr.ta.min.js b/...ssets/javascripts/lunr/min/lunr.ta.min.js → ...ssets/javascripts/lunr/min/lunr.ta.min.js
diff --git a/...ssets/javascripts/lunr/min/lunr.te.min.js → ...ssets/javascripts/lunr/min/lunr.te.min.js b/...ssets/javascripts/lunr/min/lunr.te.min.js → ...ssets/javascripts/lunr/min/lunr.te.min.js
diff --git a/...ssets/javascripts/lunr/min/lunr.th.min.js → ...ssets/javascripts/lunr/min/lunr.th.min.js b/...ssets/javascripts/lunr/min/lunr.th.min.js → ...ssets/javascripts/lunr/min/lunr.th.min.js
diff --git a/...ssets/javascripts/lunr/min/lunr.tr.min.js → ...ssets/javascripts/lunr/min/lunr.tr.min.js b/...ssets/javascripts/lunr/min/lunr.tr.min.js → ...ssets/javascripts/lunr/min/lunr.tr.min.js
diff --git a/...ssets/javascripts/lunr/min/lunr.vi.min.js → ...ssets/javascripts/lunr/min/lunr.vi.min.js b/...ssets/javascripts/lunr/min/lunr.vi.min.js → ...ssets/javascripts/lunr/min/lunr.vi.min.js
diff --git a/...ssets/javascripts/lunr/min/lunr.zh.min.js → ...ssets/javascripts/lunr/min/lunr.zh.min.js b/...ssets/javascripts/lunr/min/lunr.zh.min.js → ...ssets/javascripts/lunr/min/lunr.zh.min.js
diff --git a/site/assets/javascripts/lunr/tinyseg.js → docs/assets/javascripts/lunr/tinyseg.js b/site/assets/javascripts/lunr/tinyseg.js → docs/assets/javascripts/lunr/tinyseg.js
diff --git a/site/assets/javascripts/lunr/wordcut.js → docs/assets/javascripts/lunr/wordcut.js b/site/assets/javascripts/lunr/wordcut.js → docs/assets/javascripts/lunr/wordcut.js
diff --git a/...avascripts/workers/search.6ce7567c.min.js → ...avascripts/workers/search.6ce7567c.min.js b/...avascripts/workers/search.6ce7567c.min.js → ...avascripts/workers/search.6ce7567c.min.js
diff --git a/...cripts/workers/search.6ce7567c.min.js.map → ...cripts/workers/search.6ce7567c.min.js.map b/...cripts/workers/search.6ce7567c.min.js.map → ...cripts/workers/search.6ce7567c.min.js.map
diff --git a/.../assets/stylesheets/main.0253249f.min.css → .../assets/stylesheets/main.0253249f.min.css b/.../assets/stylesheets/main.0253249f.min.css → .../assets/stylesheets/main.0253249f.min.css
diff --git a/...ets/stylesheets/main.0253249f.min.css.map → ...ets/stylesheets/main.0253249f.min.css.map b/...ets/stylesheets/main.0253249f.min.css.map → ...ets/stylesheets/main.0253249f.min.css.map
diff --git a/...sets/stylesheets/palette.06af60db.min.css → ...sets/stylesheets/palette.06af60db.min.css b/...sets/stylesheets/palette.06af60db.min.css → ...sets/stylesheets/palette.06af60db.min.css
diff --git a/.../stylesheets/palette.06af60db.min.css.map → .../stylesheets/palette.06af60db.min.css.map b/.../stylesheets/palette.06af60db.min.css.map → .../stylesheets/palette.06af60db.min.css.map
diff --git a/...ure-proxmox-vm-network-traffic/index.html → ...ure-proxmox-vm-network-traffic/index.html b/...ure-proxmox-vm-network-traffic/index.html → ...ure-proxmox-vm-network-traffic/index.html
diff --git a/site/guides/configure-monitoring/index.html → docs/guides/configure-monitoring/index.html b/site/guides/configure-monitoring/index.html → docs/guides/configure-monitoring/index.html
diff --git a/...uides/configure-network-shares/index.html → ...uides/configure-network-shares/index.html b/...uides/configure-network-shares/index.html → ...uides/configure-network-shares/index.html
diff --git a/site/guides/configure-tailscale/index.html → docs/guides/configure-tailscale/index.html b/site/guides/configure-tailscale/index.html → docs/guides/configure-tailscale/index.html
diff --git a/site/guides/container-migration/index.html → docs/guides/container-migration/index.html b/site/guides/container-migration/index.html → docs/guides/container-migration/index.html
diff --git a/site/guides/copy-jinja-templates/index.html → docs/guides/copy-jinja-templates/index.html b/site/guides/copy-jinja-templates/index.html → docs/guides/copy-jinja-templates/index.html
diff --git a/...guides/expand-partition-debian/index.html → ...guides/expand-partition-debian/index.html b/...guides/expand-partition-debian/index.html → ...guides/expand-partition-debian/index.html
diff --git a/site/guides/linux-disk-setup/index.html → docs/guides/linux-disk-setup/index.html b/site/guides/linux-disk-setup/index.html → docs/guides/linux-disk-setup/index.html
diff --git a/...es/useful-linux-admin-commands/index.html → ...es/useful-linux-admin-commands/index.html b/...es/useful-linux-admin-commands/index.html → ...es/useful-linux-admin-commands/index.html
diff --git a/...guides/useful-proxmox-commands/index.html → ...guides/useful-proxmox-commands/index.html b/...guides/useful-proxmox-commands/index.html → ...guides/useful-proxmox-commands/index.html
diff --git a/site/index.html → docs/index.html b/site/index.html → docs/index.html
diff --git a/site/installation/production/index.html → docs/installation/production/index.html b/site/installation/production/index.html → docs/installation/production/index.html
diff --git a/...production/provision-new-hosts/index.html → ...production/provision-new-hosts/index.html b/...production/provision-new-hosts/index.html → ...production/provision-new-hosts/index.html
diff --git a/site/search/search_index.json → docs/search/search_index.json b/site/search/search_index.json → docs/search/search_index.json
diff --git a/site/sitemap.xml → docs/sitemap.xml b/site/sitemap.xml → docs/sitemap.xml
@@ -2,70 +2,70 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
          <loc>https://ferrarimarco.github.io/home-lab/</loc>
-         <lastmod>2024-10-22</lastmod>
+         <lastmod>2024-10-26</lastmod>
     </url>
     <url>
          <loc>https://ferrarimarco.github.io/home-lab/architecture/</loc>
-         <lastmod>2024-10-22</lastmod>
+         <lastmod>2024-10-26</lastmod>
     </url>
     <url>
          <loc>https://ferrarimarco.github.io/home-lab/architecture/dns-zones-servers-resolvers/</loc>
-         <lastmod>2024-10-22</lastmod>
+         <lastmod>2024-10-26</lastmod>
     </url>
     <url>
          <loc>https://ferrarimarco.github.io/home-lab/architecture/network-subnets/</loc>
-         <lastmod>2024-10-22</lastmod>
+         <lastmod>2024-10-26</lastmod>
     </url>
     <url>
          <loc>https://ferrarimarco.github.io/home-lab/architecture/references/</loc>
-         <lastmod>2024-10-22</lastmod>
+         <lastmod>2024-10-26</lastmod>
     </url>
     <url>
          <loc>https://ferrarimarco.github.io/home-lab/guides/capture-proxmox-vm-network-traffic/</loc>
-         <lastmod>2024-10-22</lastmod>
+         <lastmod>2024-10-26</lastmod>
     </url>
     <url>
          <loc>https://ferrarimarco.github.io/home-lab/guides/configure-monitoring/</loc>
-         <lastmod>2024-10-22</lastmod>
+         <lastmod>2024-10-26</lastmod>
     </url>
     <url>
          <loc>https://ferrarimarco.github.io/home-lab/guides/configure-network-shares/</loc>
-         <lastmod>2024-10-22</lastmod>
+         <lastmod>2024-10-26</lastmod>
     </url>
     <url>
          <loc>https://ferrarimarco.github.io/home-lab/guides/configure-tailscale/</loc>
-         <lastmod>2024-10-22</lastmod>
+         <lastmod>2024-10-26</lastmod>
     </url>
     <url>
          <loc>https://ferrarimarco.github.io/home-lab/guides/container-migration/</loc>
-         <lastmod>2024-10-22</lastmod>
+         <lastmod>2024-10-26</lastmod>
     </url>
     <url>
          <loc>https://ferrarimarco.github.io/home-lab/guides/copy-jinja-templates/</loc>
-         <lastmod>2024-10-22</lastmod>
+         <lastmod>2024-10-26</lastmod>
     </url>
     <url>
          <loc>https://ferrarimarco.github.io/home-lab/guides/expand-partition-debian/</loc>
-         <lastmod>2024-10-22</lastmod>
+         <lastmod>2024-10-26</lastmod>
     </url>
     <url>
          <loc>https://ferrarimarco.github.io/home-lab/guides/linux-disk-setup/</loc>
-         <lastmod>2024-10-22</lastmod>
+         <lastmod>2024-10-26</lastmod>
     </url>
     <url>
          <loc>https://ferrarimarco.github.io/home-lab/guides/useful-linux-admin-commands/</loc>
-         <lastmod>2024-10-22</lastmod>
+         <lastmod>2024-10-26</lastmod>
     </url>
     <url>
          <loc>https://ferrarimarco.github.io/home-lab/guides/useful-proxmox-commands/</loc>
-         <lastmod>2024-10-22</lastmod>
+         <lastmod>2024-10-26</lastmod>
     </url>
     <url>
          <loc>https://ferrarimarco.github.io/home-lab/installation/production/</loc>
-         <lastmod>2024-10-22</lastmod>
+         <lastmod>2024-10-26</lastmod>
     </url>
     <url>
          <loc>https://ferrarimarco.github.io/home-lab/installation/production/provision-new-hosts/</loc>
-         <lastmod>2024-10-22</lastmod>
+         <lastmod>2024-10-26</lastmod>
     </url>
 </urlset>
diff --git a/docs/sitemap.xml.gz b/docs/sitemap.xml.gz
diff --git a/site/sitemap.xml.gz b/site/sitemap.xml.gz