This project contains documentation for APTrust's Preservation Services, including ingest, restoration, deletion, and fixity checking.
This is a source repository. The public-facing documentation lives at
https://docs.aptrust.org/preservation-services-docs/, on APTrust's unified
documentation site, which is built from this repo's docs/ directory by
APTrust/aptrust-docs.
If you want to edit this documentation locally, you'll need Python 3.x and pip. To set it all up, just run
pip install -r requirements.txt. Then you can start the server with mkdocs serve.
If you get a message saying mkdocs is not installed, try running the server with this command: python3 -m mkdocs serve
mkdocs serve is for local preview only. The published site is built by
aptrust-docs, so its theme and navigation will not match what you see locally.
Push to master. That fires .github/workflows/notify-parent-docs.yml, which
tells aptrust-docs to rebuild and redeploy the unified site with your changes.
There is nothing else to run.
This repo used to publish its own copy of the guide at
https://aptrust.github.io/preserv-docs/. That address now serves only redirects
to the unified site, so old bookmarks and inbound links still work. The
redirects are generated by scripts/build_redirects.py and published to the
gh-pages branch automatically by
.github/workflows/deploy-redirects.yml on every push to master.
Do not run mkdocs gh-deploy. It would overwrite gh-pages with a second,
competing copy of the guide that immediately starts going stale. If you need to
regenerate the redirects by hand, run the generator and inspect the output
instead:
python3 scripts/build_redirects.py