Clean up legacy docs #19

New Issue

Jafner · 2024-10-27T17:06:03-07:00

Jafner commented

2024-10-27 17:06:03 -07:00

Review the docs directory with the ultimate goal of migrating to a docs-beside-code approach.

Delete docs that are no longer relevant.
Extract relevant content and place beside relevant code.

We don't want to erase institutional knowledge, but we also want to ensure our docs are maintainable and useful.

Future issues will concern building systems to keep our docs "alive".

Review the [docs](https://gitea.jafner.tools/Jafner/Jafner.net/src/branch/main/homelab/docs) directory with the ultimate goal of migrating to a docs-beside-code approach. - Delete docs that are no longer relevant. - Extract relevant content and place beside relevant code. We don't want to erase institutional knowledge, but we also want to ensure our docs are maintainable and useful. Future issues will concern building systems to keep our docs "alive".

Jafner added this to the Ongoing Cleanup and Paying Off Tech Debt milestone 2024-10-27 17:06:03 -07:00

Jafner commented

2024-10-27 17:18:00 -07:00

Many of our docs were created expressly to document imperative steps taken that cannot otherwise be represented in code, but may need to be taken again.

How do we want to store information like this? Generally, this information is "dead" in the sense that it does not actively serve any of the purposes of the repo. But it may be useful again as a shortcut to relearning the described procedure(s).

Many of our docs were created expressly to document imperative steps taken that cannot otherwise be represented in code, but may need to be taken again. How do we want to store information like this? Generally, this information is "dead" in the sense that it does not actively serve any of the purposes of the repo. But it may be useful again as a shortcut to relearning the described procedure(s).

Jafner referenced this issue from a commit

2024-10-28 18:06:13 -07:00

#19 Delete archive. Version control is my archive

Jafner referenced this issue from a commit

2024-10-28 18:06:13 -07:00

#19 Delete legacy docs, extract useful content into other docs, delete `homelab/docs/`

Jafner commented

2024-10-29 19:54:03 -07:00

All legacy docs in the docs directory have been handled.

Jafner closed this issue

2024-10-29 19:54:03 -07:00

Jafner modified the milestone from Ongoing Cleanup and Paying Off Tech Debt to Living Documentation