Skip to content

Commit addf01c

Browse files
ferrarimarcoferrarimarco
authored
chore: move docs dir to websites-src (#1865)
1 parent 6f8a619 commit addf01c

File tree

40 files changed

+68
-57
lines changed

40 files changed

+68
-57
lines changed

‎.github/workflows/documentation.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ jobs:
3535
- uses: actions/checkout@v4
3636
- name: Build the documentation site
3737
run: |
38-
scripts/run-mkdocs.sh "build"
38+
scripts/run-mkdocs.sh "build" "home-lab-docs"
3939
- name: Commit and push updates to the documentation site
4040
if: >
4141
github.event.pull_request.user.login != 'dependabot[bot]' &&

‎README.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# My Home Lab
22

33
For more information about how to set up the lab, see
4-
[the webesite](https://ferrarimarco.github.io/home-lab) or the contents of the
5-
[docs directory](./docs-src/README.md).
4+
[the webesite](https://ferrarimarco.info/home-lab).

‎config/mkdocs/home-lab-docs/mkdocs.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
3-
docs_dir: "../../../docs-src"
3+
docs_dir: "../../../websites-src/home-lab-docs"
44
repo_url: https://github.com/ferrarimarco/home-lab
55
site_dir: "../../../docs"
66
site_name: Home Lab docs
7-
site_url: https://ferrarimarco.github.io/home-lab
7+
site_url: https://ferrarimarco.info/home-lab
88
strict: true
99
theme:
1010
name: material

‎docs/architecture/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99

1010

11-
<link rel="canonical" href="https://ferrarimarco.github.io/home-lab/architecture/">
11+
<link rel="canonical" href="https://ferrarimarco.info/home-lab/architecture/">
1212

1313

1414
<link rel="prev" href="..">

‎docs/architecture/network-configuration/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99

1010

11-
<link rel="canonical" href="https://ferrarimarco.github.io/home-lab/architecture/network-configuration/">
11+
<link rel="canonical" href="https://ferrarimarco.info/home-lab/architecture/network-configuration/">
1212

1313

1414
<link rel="prev" href="../">

‎docs/architecture/references/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99

1010

11-
<link rel="canonical" href="https://ferrarimarco.github.io/home-lab/architecture/references/">
11+
<link rel="canonical" href="https://ferrarimarco.info/home-lab/architecture/references/">
1212

1313

1414
<link rel="prev" href="../network-configuration/">

‎docs/architecture/storage-configuration/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99

1010

11-
<link rel="canonical" href="https://ferrarimarco.github.io/home-lab/architecture/storage-configuration/">
11+
<link rel="canonical" href="https://ferrarimarco.info/home-lab/architecture/storage-configuration/">
1212

1313

1414
<link rel="prev" href="../references/">

‎docs/guides/capture-proxmox-vm-network-traffic/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99

1010

11-
<link rel="canonical" href="https://ferrarimarco.github.io/home-lab/guides/capture-proxmox-vm-network-traffic/">
11+
<link rel="canonical" href="https://ferrarimarco.info/home-lab/guides/capture-proxmox-vm-network-traffic/">
1212

1313

1414
<link rel="prev" href="../../architecture/storage-configuration/">

‎docs/guides/configure-monitoring/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99

1010

11-
<link rel="canonical" href="https://ferrarimarco.github.io/home-lab/guides/configure-monitoring/">
11+
<link rel="canonical" href="https://ferrarimarco.info/home-lab/guides/configure-monitoring/">
1212

1313

1414
<link rel="prev" href="../capture-proxmox-vm-network-traffic/">

‎docs/guides/configure-network-shares/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99

1010

11-
<link rel="canonical" href="https://ferrarimarco.github.io/home-lab/guides/configure-network-shares/">
11+
<link rel="canonical" href="https://ferrarimarco.info/home-lab/guides/configure-network-shares/">
1212

1313

1414
<link rel="prev" href="../configure-monitoring/">

‎docs/guides/configure-tailscale/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99

1010

11-
<link rel="canonical" href="https://ferrarimarco.github.io/home-lab/guides/configure-tailscale/">
11+
<link rel="canonical" href="https://ferrarimarco.info/home-lab/guides/configure-tailscale/">
1212

1313

1414
<link rel="prev" href="../configure-network-shares/">

‎docs/guides/container-migration/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99

1010

11-
<link rel="canonical" href="https://ferrarimarco.github.io/home-lab/guides/container-migration/">
11+
<link rel="canonical" href="https://ferrarimarco.info/home-lab/guides/container-migration/">
1212

1313

1414
<link rel="prev" href="../configure-tailscale/">

‎docs/guides/copy-jinja-templates/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99

1010

11-
<link rel="canonical" href="https://ferrarimarco.github.io/home-lab/guides/copy-jinja-templates/">
11+
<link rel="canonical" href="https://ferrarimarco.info/home-lab/guides/copy-jinja-templates/">
1212

1313

1414
<link rel="prev" href="../container-migration/">

‎docs/guides/linux-disk-setup/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99

1010

11-
<link rel="canonical" href="https://ferrarimarco.github.io/home-lab/guides/linux-disk-setup/">
11+
<link rel="canonical" href="https://ferrarimarco.info/home-lab/guides/linux-disk-setup/">
1212

1313

1414
<link rel="prev" href="../copy-jinja-templates/">

‎docs/guides/useful-linux-admin-commands/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99

1010

11-
<link rel="canonical" href="https://ferrarimarco.github.io/home-lab/guides/useful-linux-admin-commands/">
11+
<link rel="canonical" href="https://ferrarimarco.info/home-lab/guides/useful-linux-admin-commands/">
1212

1313

1414
<link rel="prev" href="../linux-disk-setup/">

‎docs/guides/useful-proxmox-commands/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99

1010

11-
<link rel="canonical" href="https://ferrarimarco.github.io/home-lab/guides/useful-proxmox-commands/">
11+
<link rel="canonical" href="https://ferrarimarco.info/home-lab/guides/useful-proxmox-commands/">
1212

1313

1414
<link rel="prev" href="../useful-linux-admin-commands/">

‎docs/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99

1010

11-
<link rel="canonical" href="https://ferrarimarco.github.io/home-lab/">
11+
<link rel="canonical" href="https://ferrarimarco.info/home-lab/">
1212

1313

1414

‎docs/installation/production/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99

1010

11-
<link rel="canonical" href="https://ferrarimarco.github.io/home-lab/installation/production/">
11+
<link rel="canonical" href="https://ferrarimarco.info/home-lab/installation/production/">
1212

1313

1414
<link rel="prev" href="../../guides/useful-proxmox-commands/">

‎docs/installation/production/provision-new-hosts/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99

1010

11-
<link rel="canonical" href="https://ferrarimarco.github.io/home-lab/installation/production/provision-new-hosts/">
11+
<link rel="canonical" href="https://ferrarimarco.info/home-lab/installation/production/provision-new-hosts/">
1212

1313

1414
<link rel="prev" href="../">

‎docs/installation/production/setup-proxmox/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99

1010

11-
<link rel="canonical" href="https://ferrarimarco.github.io/home-lab/installation/production/setup-proxmox/">
11+
<link rel="canonical" href="https://ferrarimarco.info/home-lab/installation/production/setup-proxmox/">
1212

1313

1414
<link rel="prev" href="../provision-new-hosts/">

‎docs/sitemap.xml

+34-34
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,71 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
33
<url>
4-
<loc>https://ferrarimarco.github.io/home-lab/</loc>
5-
<lastmod>2025-02-28</lastmod>
4+
<loc>https://ferrarimarco.info/home-lab/</loc>
5+
<lastmod>2025-03-08</lastmod>
66
</url>
77
<url>
8-
<loc>https://ferrarimarco.github.io/home-lab/architecture/</loc>
9-
<lastmod>2025-02-28</lastmod>
8+
<loc>https://ferrarimarco.info/home-lab/architecture/</loc>
9+
<lastmod>2025-03-08</lastmod>
1010
</url>
1111
<url>
12-
<loc>https://ferrarimarco.github.io/home-lab/architecture/network-configuration/</loc>
13-
<lastmod>2025-02-28</lastmod>
12+
<loc>https://ferrarimarco.info/home-lab/architecture/network-configuration/</loc>
13+
<lastmod>2025-03-08</lastmod>
1414
</url>
1515
<url>
16-
<loc>https://ferrarimarco.github.io/home-lab/architecture/references/</loc>
17-
<lastmod>2025-02-28</lastmod>
16+
<loc>https://ferrarimarco.info/home-lab/architecture/references/</loc>
17+
<lastmod>2025-03-08</lastmod>
1818
</url>
1919
<url>
20-
<loc>https://ferrarimarco.github.io/home-lab/architecture/storage-configuration/</loc>
21-
<lastmod>2025-02-28</lastmod>
20+
<loc>https://ferrarimarco.info/home-lab/architecture/storage-configuration/</loc>
21+
<lastmod>2025-03-08</lastmod>
2222
</url>
2323
<url>
24-
<loc>https://ferrarimarco.github.io/home-lab/guides/capture-proxmox-vm-network-traffic/</loc>
25-
<lastmod>2025-02-28</lastmod>
24+
<loc>https://ferrarimarco.info/home-lab/guides/capture-proxmox-vm-network-traffic/</loc>
25+
<lastmod>2025-03-08</lastmod>
2626
</url>
2727
<url>
28-
<loc>https://ferrarimarco.github.io/home-lab/guides/configure-monitoring/</loc>
29-
<lastmod>2025-02-28</lastmod>
28+
<loc>https://ferrarimarco.info/home-lab/guides/configure-monitoring/</loc>
29+
<lastmod>2025-03-08</lastmod>
3030
</url>
3131
<url>
32-
<loc>https://ferrarimarco.github.io/home-lab/guides/configure-network-shares/</loc>
33-
<lastmod>2025-02-28</lastmod>
32+
<loc>https://ferrarimarco.info/home-lab/guides/configure-network-shares/</loc>
33+
<lastmod>2025-03-08</lastmod>
3434
</url>
3535
<url>
36-
<loc>https://ferrarimarco.github.io/home-lab/guides/configure-tailscale/</loc>
37-
<lastmod>2025-02-28</lastmod>
36+
<loc>https://ferrarimarco.info/home-lab/guides/configure-tailscale/</loc>
37+
<lastmod>2025-03-08</lastmod>
3838
</url>
3939
<url>
40-
<loc>https://ferrarimarco.github.io/home-lab/guides/container-migration/</loc>
41-
<lastmod>2025-02-28</lastmod>
40+
<loc>https://ferrarimarco.info/home-lab/guides/container-migration/</loc>
41+
<lastmod>2025-03-08</lastmod>
4242
</url>
4343
<url>
44-
<loc>https://ferrarimarco.github.io/home-lab/guides/copy-jinja-templates/</loc>
45-
<lastmod>2025-02-28</lastmod>
44+
<loc>https://ferrarimarco.info/home-lab/guides/copy-jinja-templates/</loc>
45+
<lastmod>2025-03-08</lastmod>
4646
</url>
4747
<url>
48-
<loc>https://ferrarimarco.github.io/home-lab/guides/linux-disk-setup/</loc>
49-
<lastmod>2025-02-28</lastmod>
48+
<loc>https://ferrarimarco.info/home-lab/guides/linux-disk-setup/</loc>
49+
<lastmod>2025-03-08</lastmod>
5050
</url>
5151
<url>
52-
<loc>https://ferrarimarco.github.io/home-lab/guides/useful-linux-admin-commands/</loc>
53-
<lastmod>2025-02-28</lastmod>
52+
<loc>https://ferrarimarco.info/home-lab/guides/useful-linux-admin-commands/</loc>
53+
<lastmod>2025-03-08</lastmod>
5454
</url>
5555
<url>
56-
<loc>https://ferrarimarco.github.io/home-lab/guides/useful-proxmox-commands/</loc>
57-
<lastmod>2025-02-28</lastmod>
56+
<loc>https://ferrarimarco.info/home-lab/guides/useful-proxmox-commands/</loc>
57+
<lastmod>2025-03-08</lastmod>
5858
</url>
5959
<url>
60-
<loc>https://ferrarimarco.github.io/home-lab/installation/production/</loc>
61-
<lastmod>2025-02-28</lastmod>
60+
<loc>https://ferrarimarco.info/home-lab/installation/production/</loc>
61+
<lastmod>2025-03-08</lastmod>
6262
</url>
6363
<url>
64-
<loc>https://ferrarimarco.github.io/home-lab/installation/production/provision-new-hosts/</loc>
65-
<lastmod>2025-02-28</lastmod>
64+
<loc>https://ferrarimarco.info/home-lab/installation/production/provision-new-hosts/</loc>
65+
<lastmod>2025-03-08</lastmod>
6666
</url>
6767
<url>
68-
<loc>https://ferrarimarco.github.io/home-lab/installation/production/setup-proxmox/</loc>
69-
<lastmod>2025-02-28</lastmod>
68+
<loc>https://ferrarimarco.info/home-lab/installation/production/setup-proxmox/</loc>
69+
<lastmod>2025-03-08</lastmod>
7070
</url>
7171
</urlset>

‎docs/sitemap.xml.gz

-5 Bytes
Binary file not shown.

‎scripts/run-mkdocs.sh

+13-1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ echo "Running mkdocs: ${MKDOCS_CONTAINER_IMAGE}"
1212
SUBCOMMAND="${1}"
1313
echo "Subcommand: ${SUBCOMMAND}"
1414

15+
MKDOCS_CONFIG_FILE_DIRECTORY_NAME="${2}"
16+
echo "Mkdocs config file directory name: ${MKDOCS_CONFIG_FILE_DIRECTORY_NAME}"
17+
1518
RUN_CONTAINER_COMMAND=(
1619
docker run
1720
--rm
@@ -32,8 +35,14 @@ RUN_CONTAINER_COMMAND+=(
3235
"${MKDOCS_CONTAINER_IMAGE}"
3336
)
3437

38+
MKDOCS_CONFIG_FILE_PATH="config/mkdocs/${MKDOCS_CONFIG_FILE_DIRECTORY_NAME}/mkdocs.yaml"
39+
if [[ ! -f "${MKDOCS_CONFIG_FILE_PATH}" ]]; then
40+
echo "Mkdocs config file (${MKDOCS_CONFIG_FILE_PATH}) doesn't exist or is not readable"
41+
exit "${ERR_ARGUMENT_EVAL}"
42+
fi
43+
3544
DEFAULT_MKDOCS_ARGS=(
36-
--config-file config/mkdocs/home-lab-docs/mkdocs.yaml
45+
--config-file "${MKDOCS_CONFIG_FILE_PATH}"
3746
)
3847

3948
if [[ "${SUBCOMMAND}" == "serve" ]]; then
@@ -52,6 +61,9 @@ elif [[ "${SUBCOMMAND}" == "create" ]]; then
5261
"new"
5362
.
5463
)
64+
else
65+
echo "Set a mkdocs subcommand using the first argument"
66+
exit "${ERR_ARGUMENT_EVAL}"
5567
fi
5668

5769
echo "Run container command: ${RUN_CONTAINER_COMMAND[*]}"

‎docs-src/README.md ‎websites-src/home-lab-docs/README.md

File renamed without changes.

‎docs-src/architecture/README.md ‎websites-src/home-lab-docs/architecture/README.md

File renamed without changes.

‎docs-src/architecture/network-configuration.md ‎websites-src/home-lab-docs/architecture/network-configuration.md

File renamed without changes.

‎docs-src/architecture/references.md ‎websites-src/home-lab-docs/architecture/references.md

File renamed without changes.

‎docs-src/architecture/storage-configuration.md ‎websites-src/home-lab-docs/architecture/storage-configuration.md

File renamed without changes.

‎docs-src/guides/capture-proxmox-vm-network-traffic.md ‎websites-src/home-lab-docs/guides/capture-proxmox-vm-network-traffic.md

File renamed without changes.

‎docs-src/guides/configure-monitoring.md ‎websites-src/home-lab-docs/guides/configure-monitoring.md

File renamed without changes.

‎docs-src/guides/configure-network-shares.md ‎websites-src/home-lab-docs/guides/configure-network-shares.md

File renamed without changes.

‎docs-src/guides/configure-tailscale.md ‎websites-src/home-lab-docs/guides/configure-tailscale.md

File renamed without changes.

‎docs-src/guides/container-migration.md ‎websites-src/home-lab-docs/guides/container-migration.md

File renamed without changes.

‎docs-src/guides/copy-jinja-templates.md ‎websites-src/home-lab-docs/guides/copy-jinja-templates.md

File renamed without changes.

‎docs-src/guides/linux-disk-setup.md ‎websites-src/home-lab-docs/guides/linux-disk-setup.md

File renamed without changes.

‎docs-src/guides/useful-linux-admin-commands.md ‎websites-src/home-lab-docs/guides/useful-linux-admin-commands.md

File renamed without changes.

‎docs-src/guides/useful-proxmox-commands.md ‎websites-src/home-lab-docs/guides/useful-proxmox-commands.md

File renamed without changes.

‎docs-src/installation/production/README.md ‎websites-src/home-lab-docs/installation/production/README.md

File renamed without changes.

‎docs-src/installation/production/provision-new-hosts.md ‎websites-src/home-lab-docs/installation/production/provision-new-hosts.md

File renamed without changes.

‎docs-src/installation/production/setup-proxmox.md ‎websites-src/home-lab-docs/installation/production/setup-proxmox.md

File renamed without changes.

0 commit comments

Comments
 (0)