diff options
| author |  Johannes Christ <[email protected]> | 2024-07-24 20:09:42 +0200 |
|---|---|---|
| committer | Johannes Christ <[email protected]> | 2024-07-25 20:06:54 +0200 |
| commit | a4d7e92d544aeb43dbe1fcd8648d97e0dbf7b9d3 (patch) | |
| tree | 183318852234388654c99514e45f095af8c21676 /docs/README.md | |
| parent | Add link to DevOps Kanban board in meeting template (#420) (diff) | |
Improve documentation
This commit ports our documentation to Sphinx.
The reason for this is straightforward. We need to improve both the
quality and the accessibility of our documentation. Hugo is not capable
of doing this, as its primary output format is HTML. Sphinx builds
plenty of high-quality output formats out of the box, and incentivizes
writing good documentation.
Diffstat (limited to 'docs/README.md')
| -rw-r--r-- | docs/README.md | 9 |
1 files changed, 0 insertions, 9 deletions
diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index eaef124..0000000 --- a/docs/README.md +++ /dev/null @@ -1,9 +0,0 @@ -# DevOps documentation - -This directory houses our DevOps documentation, written using -[Hugo](https://gohugo.io). - -To test changes to it locally, run `hugo serve` and follow the link displayed -on your Terminal. To generate all files, just run `hugo`. - -<!-- vim: set textwidth=80 sw=2 ts=2: --> |