mirrors/khuedoan-homelab
1
0
Fork 0
mirror of https://github.com/khuedoan/homelab.git synced 2024-12-22 20:54:33 +07:00
Code Issues Packages Projects Releases Wiki Activity

docs: add index pages for overview content

Browse Source
This commit is contained in:
Khue Doan 2022-09-20 23:47:06 +07:00
parent 1405fadf1a
commit ba2d3d8c74
10 changed files with 27 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/concepts/index.md Normal file
View File

@ -0,0 +1 @@
# Concepts

1
docs/getting-started/index.md Normal file
View File

@ -0,0 +1 @@
# Getting started

1
docs/how-to-guides/index.md Normal file
View File

@ -0,0 +1 @@
# How-to guides

1
docs/how-to-guides/troubleshooting/index.md Normal file
View File

@ -0,0 +1 @@
# Troubleshooting

13
docs/concepts/documentation.md → docs/how-to-guides/updating-documentation.md
View File

@ -1,7 +1,14 @@
# Documentation (this website)
# Updating documentation (this website)
The project uses the [Diátaxis](https://diataxis.fr) technical documentation framework.
It can be viewed at <https://homelab.khuedoan.com>.
This project uses the [Diátaxis](https://diataxis.fr) technical documentation framework.
The website is generated using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material) and can be viewed at [homelab.khuedoan.com](https://homelab.khuedoan.com).
There are 4 main parts:
- [Getting started (tutorials)](https://diataxis.fr/tutorials): learning-oriented
- [Concepts (explanation)](https://diataxis.fr/explanation): understanding-oriented
- [How-to guides](https://diataxis.fr/how-to-guides): goal-oriented
- [Reference](https://diataxis.fr/reference): information-oriented
## Local development

1
docs/installation/index.md Normal file
View File

@ -0,0 +1 @@
# Installation

1
docs/installation/production/index.md Normal file
View File

@ -0,0 +1 @@
# Production

1
docs/reference/architecture/index.md Normal file
View File

@ -0,0 +1 @@
# Architecture

1
docs/reference/index.md Normal file
View File

@ -0,0 +1 @@
# Reference

11
mkdocs.yml
View File

@ -11,7 +11,6 @@ theme:
primary: black
features:
- navigation.indexes
- navigation.expand
- search.highlight
- search.share
@ -37,22 +36,26 @@ markdown_extensions:
nav:
- Home: index.md
- Installation:
- installation/index.md
- installation/sandbox.md
- Production:
- installation/production/index.md
- installation/production/prerequisites.md
- installation/production/external-resources.md
- installation/production/configuration.md
- installation/production/deployment.md
- installation/post-installation.md
- Getting started:
- getting-started/index.md
- getting-started/user-onboarding.md
- getting-started/install-pre-commit-hooks.md
- Concepts:
- concepts/documentation.md
- concepts/index.md
- concepts/pxe-boot.md
- concepts/secrets-management.md
- concepts/tools-container.md
- How-to guides:
- how-to-guides/index.md
- how-to-guides/alternate-dns-setup.md
- how-to-guides/expose-services-to-the-internet.md
- how-to-guides/use-both-github-and-gitea.md
@ -60,7 +63,9 @@ nav:
- how-to-guides/run-commands-on-multiple-nodes.md
- how-to-guides/single-node-cluster-adjustments.md
- how-to-guides/disable-dhcp-proxy-in-dnsmasq.md
- how-to-guides/updating-documentation.md
- Troubleshooting:
- how-to-guides/troubleshooting/index.md
- how-to-guides/troubleshooting/argocd.md
- how-to-guides/troubleshooting/cert-manager.md
- how-to-guides/troubleshooting/gitea.md
@ -68,7 +73,9 @@ nav:
- how-to-guides/troubleshooting/pxe-boot.md
- how-to-guides/troubleshooting/vault.md
- Reference:
- reference/index.md
- Architecture:
- reference/architecture/index.md
- reference/architecture/overview.md
- reference/architecture/networking.md
- reference/architecture/decision-records.md