mirrors/khuedoan-homelab
1
0
Fork 0
mirror of https://github.com/khuedoan/homelab.git synced 2025-07-06 16:29:09 +07:00
Code Issues Packages Projects Releases Wiki Activity

style(docs): use hyphens instead of underscores in file names

Browse Source
This commit is contained in:
Khue Doan
2022-02-22 21:29:55 +07:00
parent d9cee10ff8
commit 0ef2aa0de1
8 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -199,7 +199,7 @@ They can't capture all of the project's features, but they are sufficient to get
## Get Started
- [Try it out on a VM](https://homelab.khuedoan.com/try_on_a_vm.html) without any hardware
- [Try it out on a VM](https://homelab.khuedoan.com/try-on-a-vm.html) without any hardware
- [Deploy on real hardware](https://homelab.khuedoan.com/deployment) for real workload
## Roadmap

8
docs/src/SUMMARY.md
View File

@ -1,17 +1,17 @@
# Summary
- [Introduction](introduction.md)
- [Try on a VM](try_on_a_vm.md)
- [Try on a VM](try-on-a-vm.md)
- [Deployment](./deployment/README.md)
- [Provisioning flow](./deployment/provisioning_flow.md)
- [Provisioning flow](./deployment/provisioning-flow.md)
- [Prerequisites](./deployment/prerequisites.md)
- [Configuration](./deployment/configuration.md)
- [Deploy the homelab](./deployment/deployment.md)
- [DNS setup](./deployment/dns.md)
- [External resources (optional)](./deployment/external_resources.md)
- [External resources (optional)](./deployment/external-resources.md)
- [Troubleshooting](./troubleshooting.md)
- [Tutorials]()
- [Single node cluster adjustments](./tutorials/single_node_cluster_adjustments.md)
- [Single node cluster adjustments](./tutorials/single-node-cluster-adjustments.md)
- [Add or remove nodes (scale up or down)](./tutorials/add-or-remove-nodes.md)
- [Run commands on multiple nodes](./tutorials/run-commands-on-multiple-nodes.md)
- [Install new applications]()

2
docs/src/deployment/README.md
View File

@ -7,4 +7,4 @@ In this section you will learn how to:
- Build the cluster and bootstrap it
- Perform some addtional steps depending on your set up (DNS, external secrets...)
If you encounter any issue, please see the [Troubleshooting](../troubleshooting) section.
If you encounter any issue, please see the [Troubleshooting](../troubleshooting.md) section.

0
docs/src/deployment/external_resources.md → docs/src/deployment/external-resources.md
View File

12
docs/src/deployment/prerequisites.md
View File

@ -14,12 +14,12 @@ Any modern `x86_64` computer(s) should work, you can use old PCs, laptops or ser
> This is the requirements for _each_ node
| Component | Minimum | Recommended |
| :-- | :-- | :-- |
| CPU | 2 cores | 4 cores |
| RAM | 8 GB | 16 GB |
| Hard drive | 128 GB | 512 GB (depending on your storage usage, the base installation will not use more than 128GB) |
| Node count | 1 (checkout the [single node cluster adjustments](../tutorials/single_node_cluster_adjustments.md) tutorial) | 3 or more for high availability |
| Component | Minimum | Recommended |
| :-- | :-- | :-- |
| CPU | 2 cores | 4 cores |
| RAM | 8 GB | 16 GB |
| Hard drive | 128 GB | 512 GB (depending on your storage usage, the base installation will not use more than 128GB) |
| Node count | 1 (checkout the [single node cluster adjustments](../tutorials/single-node-cluster-adjustments.md) tutorial) | 3 or more for high availability |
Additional capabilities:

0
docs/src/deployment/provisioning_flow.md → docs/src/deployment/provisioning-flow.md
View File

0
docs/src/try_on_a_vm.md → docs/src/try-on-a-vm.md
View File

0
docs/src/tutorials/single_node_cluster_adjustments.md → docs/src/tutorials/single-node-cluster-adjustments.md
View File