userguide

User guide for APTrust users.

This repo is a source repository. The markdown in docs/ is pulled in by APTrust/aptrust-docs, which builds and publishes the unified documentation site. The published guide lives at:

https://docs.aptrust.org/user-guide/

Pushing to master notifies aptrust-docs, which rebuilds and redeploys the unified site automatically.

Local Editing

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.yml and requirements.txt are kept solely for this local preview. The local build is a preview only — it is not what readers see.

Deploying

There is nothing to deploy from here. Merging to master is the whole publish step: aptrust-docs rebuilds https://docs.aptrust.org/user-guide/ with the new content.

Do not run mkdocs gh-deploy. This repo's gh-pages branch no longer holds a copy of the guide. It serves only redirect stubs that forward the old standalone address, https://aptrust.github.io/userguide/, to the unified site, so old bookmarks and inbound links keep working. Running gh-deploy would overwrite those redirects with a stale duplicate of the site — exactly the problem this setup removes.

The redirects are generated by scripts/build_redirects.py and published to gh-pages by the Deploy Redirects to GitHub Pages workflow on every push to master. To re-publish them without pushing a commit, run that workflow manually from the Actions tab. If you add or rename a page in docs/, the matching redirect is created on the next push — no manual step needed.