|
||
---|---|---|
docs | ||
LICENSES | ||
.drone.yml | ||
.gitignore | ||
Dockerfile | ||
push-to-docs.sh | ||
README.md |
docs-centralizer
A small helper script running in CI that cross-publishes project-specific documentation to docs.fsfe.org.
Table of Contents
Background
Install
You can clone this repo by running:
git clone git@git.fsfe.org:fsfe-system-hackers/docs-centralizer.git
Then, you can build the container image:
docker build . -t docs-centralizer:dev
Then the script should only be run in a container. In order for this to work, the following environment variables need to be set.
-
SSH_PRIVATE_KEY
: The private SSH key (without the-----BEGIN/END OPENSSH PRIVATE KEY-----
) of thedocs-bot
user. -
REPO_NAME
: The name of the repository whose documentation you want to publish to https://docs.fsfe.org. For example, theREPO_NAME
in this project would bedocs-centralizer
Finally, simply run the container to test your changes:
docker run \
-e SSH_PRIVATE_KEY \
-e REPO_NAME='docs-centralizer' \
-v $(pwd):/src docs-centralizer:dev
Usage
In order to integrate the docs from your repository into our centralized
documentation at https://docs.fsfe.org, simply add the following step to
the .drone.yml
of your new repo:
- name: push-to-docs
image: git.fsfe.org/fsfe-system-hackers/docs-centralizer:latest
environment:
REPO_NAME: example-repository
SSH_PRIVATE_KEY:
# This is an organisation secret, so you don't need to set it
from_secret: docs_bot_private_key
when:
branch:
- master
event:
- push
To indicate that this repo's documentation is on https://docs.fsfe.org, please add this badge:
[](https://docs.fsfe.org/repodocs/<repo_name>/00_README)
where you replace <repo_name>
at the end with the name of the respective
repo.
Maintainers
Contributing
PRs accepted.
Small note: If editing the README, please conform to the standard-readme specification.
License
GPL-3.0-or-later © 2022 Free Software Foundation Europe