Skip to content

Commit 004855d

Browse files
authored
Merge pull request #5178 from jluhrsen/mkdocs-serve-update
update requirements.txt to use minify-html
2 parents 18d7d1c + 817186b commit 004855d

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

docs/developer-guide/documentation.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,14 @@ a GitHub Action workflow that will automatically publish the changes to the webs
6666

6767
## How to test your documentation changes?
6868

69+
### Option 1) Build and view docs with a PR
70+
71+
Pushing docs changes to the ovn-kubernetes/ovn-kubernetes project as a pull request will
72+
run the job name "[Test and Deploy static content to Pages](https://github.com/ovn-kubernetes/ovn-kubernetes/blob/master/.github/workflows/docs.yml)" which has a step to save the
73+
docs artifacts. You can download those as a .zip file, extract and view them locally.
74+
75+
### Option 2) Build and serve docs locally
76+
6977
In order to test changes locally to either mkdocs.yml or to files under docs/ folder,
7078
please follow the instructions below.
7179

requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Click
2-
htmlmin
2+
minify-html
33
Jinja2
44
jsmin
55
livereload

0 commit comments

Comments
 (0)