Skip to content

Commit 7f15fbc

Browse files
committed
updated README
1 parent 26f3907 commit 7f15fbc

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
[![Deploy site](https://github.com/openssl/openssl-docs/actions/workflows/deploy-site.yaml/badge.svg?branch=gh-pages)](https://github.com/openssl/openssl-docs/actions/workflows/deploy-site.yaml)
2+
13
# docs.openssl.org
24

35
OpenSSL Documentation website is based on
@@ -6,6 +8,11 @@ this repository contains required configuration and build scripts.
68

79
## Deployment
810

11+
The website is automatically rebuilt on changes in `doc` directory of `openssl/openssl`. Then a
12+
new commit is pushed to `gh-pages` branch which triggers
13+
[pages-build-deployment](https://github.com/openssl/openssl-docs/actions/workflows/pages/pages-build-deployment)
14+
GitHub Actions workflow.
15+
916
To deploy documentation website manually trigger
1017
[Deploy site](https://github.com/openssl/openssl-docs/actions/workflows/deploy-site.yaml) GitHub
1118
Actions workflow.
@@ -31,6 +38,7 @@ To start playing around you can spin up a container and run commands:
3138

3239
```sh
3340
python build.py <OPENSSL VERSION>
41+
```
3442

3543
4. Run the development web server:
3644

0 commit comments

Comments
 (0)