Feature #55
Updated by koszko over 1 year ago
We need to document current workings, as well as planned future mechanisms of Hydrilla. The best place for this is going to be the Wiki here.
Things that need documenting and come to my mind:
- ~~codebase description, what does what and how do things interact~~ - docstrings currently present in the new Hydrilla sources should suffice
- ~~data format description - how site resources are stored in the filesystem (the other side - data format for network communication - is already being worked on[^1])~~ both are being finished right now
- how to run Hydrilla
- a sample (also, we need to add an example Apache (later also Nginx) config as Hydrilla is meant to sit behind a reverse proxy
- manpages for `hydrilla` and `hydrilla-builder`
This will be needed for Hydrilla 1.0. The 1.0-beta1 pre-release can be made without such thorough documentation
[^1]: https://hachettebugs.koszko.org/issues/50#change-104
Things that need documenting and come to my mind:
- ~~codebase description, what does what and how do things interact~~ - docstrings currently present in the new Hydrilla sources should suffice
- ~~data format description - how site resources are stored in the filesystem (the other side - data format for network communication - is already being worked on[^1])~~ both are being finished right now
- how to run Hydrilla
- a sample (also, we need to add an example Apache (later also Nginx) config as Hydrilla is meant to sit behind a reverse proxy
- manpages for `hydrilla` and `hydrilla-builder`
This will be needed for Hydrilla 1.0. The 1.0-beta1 pre-release can be made without such thorough documentation
[^1]: https://hachettebugs.koszko.org/issues/50#change-104