From 74607fdd430e1cdc21c19492c83666e5f2f5c3f2 Mon Sep 17 00:00:00 2001 From: Dan Helfman Date: Wed, 30 Oct 2019 10:54:42 -0700 Subject: [PATCH] Documentation on how to develop borgmatic's documentation. --- NEWS | 4 ++++ docs/how-to/develop-on-borgmatic.md | 23 +++++++++++++++++++++++ setup.py | 2 +- 3 files changed, 28 insertions(+), 1 deletion(-) diff --git a/NEWS b/NEWS index 7798dde..7339459 100644 --- a/NEWS +++ b/NEWS @@ -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 * #225: Database dump hooks for PostgreSQL, so you can easily dump your databases before backups run. diff --git a/docs/how-to/develop-on-borgmatic.md b/docs/how-to/develop-on-borgmatic.md index e618cff..ad26b2f 100644 --- a/docs/how-to/develop-on-borgmatic.md +++ b/docs/how-to/develop-on-borgmatic.md @@ -107,6 +107,29 @@ suite. You can view these builds on [build.torsion.org](https://build.torsion.org/witten/borgmatic), and they're 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 * [Inspect your backups](https://torsion.org/borgmatic/docs/how-to/inspect-your-backups/) diff --git a/setup.py b/setup.py index 6f4cef6..d389b33 100644 --- a/setup.py +++ b/setup.py @@ -1,6 +1,6 @@ from setuptools import find_packages, setup -VERSION = '1.4.0' +VERSION = '1.4.1.dev0' setup(