Skip to content

Commit 26f3907

Browse files
committed
add Deployment section into README
1 parent 7ff0a00 commit 26f3907

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@ OpenSSL Documentation website is based on
44
[Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) and
55
this repository contains required configuration and build scripts.
66

7+
## Deployment
8+
9+
To deploy documentation website manually trigger
10+
[Deploy site](https://github.com/openssl/openssl-docs/actions/workflows/deploy-site.yaml) GitHub
11+
Actions workflow.
12+
713
## Local development
814

915
All required dependencies are packed into a container image `quay.io/openssl-ci/docs`.
@@ -32,8 +38,22 @@ To start playing around you can spin up a container and run commands:
3238
mike serve -a 0.0.0.0:8000
3339
```
3440

35-
## Deployment
41+
## build.py
42+
43+
A small wrapper script to clone a specific OpenSSL branch and build documentaton website with
44+
`mike`. Run it to build the website:
45+
46+
```sh
47+
python build.py <OPENSSL VERSION>
48+
```
49+
50+
`mike` puts generated content into a separate branch `gh-pages`. Please refer `mike`
51+
[documentation](https://github.com/jimporter/mike) for the details.
52+
53+
## hooks.py
3654

55+
All pre- and post- processing is done via `MkDocs` hooks. Please refer `MkDocs`
56+
[documentation](https://www.mkdocs.org/dev-guide/plugins/#events) for the details.
3757

3858

3959
## References

0 commit comments

Comments
 (0)