Documentation on how to develop borgmatic's documentation.

This commit is contained in:
Dan Helfman 2019-10-30 10:54:42 -07:00
parent b53684a8f0
commit 74607fdd43
3 changed files with 28 additions and 1 deletions

4
NEWS
View file

@ -1,3 +1,7 @@
1.4.1.dev0
* Documentation on how to develop borgmatic's documentation:
https://torsion.org/borgmatic/docs/how-to/develop-on-borgmatic/#documentation-development
1.4.0 1.4.0
* #225: Database dump hooks for PostgreSQL, so you can easily dump your databases before backups * #225: Database dump hooks for PostgreSQL, so you can easily dump your databases before backups
run. run.

View file

@ -107,6 +107,29 @@ suite. You can view these builds on
[build.torsion.org](https://build.torsion.org/witten/borgmatic), and they're [build.torsion.org](https://build.torsion.org/witten/borgmatic), and they're
also linked from the commits list on each pull request. also linked from the commits list on each pull request.
## Documentation development
Updates to borgmatic's documentation are welcome. It's formatted in Markdown
and located in the `docs/` directory in borgmatic's source, plus the
`README.md` file at the root.
To build and view a copy of the documentation with your local changes, just
run the following from the root of borgmatic's source code:
```bash
sudo scripts/dev-docs
```
This requires Docker to be installed on your system. You may not need to use
sudo if your non-root user has permissions to run Docker.
After you run the script, you can point your web browser at
http://localhost:8080 to view the documentation with your changes.
To close the documentation server, ctrl-C the script. Note that it does not
currently auto-reload, so you'll need to stop it and re-run it for any
additional documentation changes to take effect.
## Related documentation ## Related documentation
* [Inspect your backups](https://torsion.org/borgmatic/docs/how-to/inspect-your-backups/) * [Inspect your backups](https://torsion.org/borgmatic/docs/how-to/inspect-your-backups/)

View file

@ -1,6 +1,6 @@
from setuptools import find_packages, setup from setuptools import find_packages, setup
VERSION = '1.4.0' VERSION = '1.4.1.dev0'
setup( setup(