PowerDNS / lightningstream

Lightning Stream syncs LMDB databases through S3 buckets between multiple servers, including PowerDNS Authoritative server 4.8+ LMDBs
https://doc.powerdns.com/lightningstream/
MIT License
28 stars 16 forks source link

Add documentation #29

Closed wojas closed 1 year ago

wojas commented 1 year ago

Writing documentation using mkdocs.

To view them locally from a checkout of the repo:

python3 -m venv .venv
.venv/bin/pip install -r docs/requirements.txt
.venv/bin/mkdocs serve
neilcook commented 1 year ago

.venv/bin/pip install -r requirements.txt

Should be:

.venv/bin/pip install -r docs/requirements.txt

Or mkdocs.yml needs to be in the docs directory.

wojas commented 1 year ago

Should be: .venv/bin/pip install -r docs/requirements.txt

Thanks, updated.

Or mkdocs.yml needs to be in the docs directory.

MkDocs is picky about it not being in the docs directory, unfortunately.