Skip to content

Commit 91b429e

Browse files
authored
Re-enable strict mode in docs vlidation. Bump mkdocs-material version (lensapp#3073)
- Re-enable strict mode in the verify docs command now that the latest version of mkdocs-material is available and supports the new Google Analytics layout - Amend mkdocs config to use the new Google Analytics layout - Bump to use latest 1.2 version of mkdocs Note - current issue mkdocs/mkdocs#2457 stops live reload from work in mkdocs 1.2 so developers will need to amend the mkdocs.yml to pin mkdocs to version 1.1.2 Signed-off-by: Steve Richards <[email protected]>
1 parent 247b00a commit 91b429e

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

mkdocs.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,6 @@ repo_name: GitHub
77
repo_url: https://github.com/lensapp/lens
88
copyright: Copyright &copy; 2021 <a href="https://mirantis.com/">Mirantis Inc.</a> - All rights reserved.
99
edit_uri: ""
10-
google_analytics:
11-
- UA-159377374-2
12-
- auto
1310
nav:
1411
- Overview: README.md
1512
- Getting Started:
@@ -87,3 +84,6 @@ extra:
8784
name: Lens Website
8885
version:
8986
method: mike
87+
analytics:
88+
provider: google
89+
property: UA-159377374-2

mkdocs/requirements.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Direct dependencies
2-
mkdocs>=1.1
2+
mkdocs>=1.2
33
Pygments>=2.4
44
markdown>=3.2
55
pymdown-extensions>=7.0
66
mkdocs-material-extensions>=1.0
77
mkdocs-git-revision-date-localized-plugin>=0.7.3
8-
mkdocs-material>=6.1.0
8+
mkdocs-material>=7.1.8

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
"lint": "yarn run eslint --ext js,ts,tsx --max-warnings=0 .",
4040
"lint:fix": "yarn run lint --fix",
4141
"mkdocs-serve-local": "docker build -t mkdocs-serve-local:latest mkdocs/ && docker run --rm -it -p 8000:8000 -v ${PWD}:/docs mkdocs-serve-local:latest",
42-
"verify-docs": "docker build -t mkdocs-serve-local:latest mkdocs/ && docker run --rm -v ${PWD}:/docs mkdocs-serve-local:latest build",
42+
"verify-docs": "docker build -t mkdocs-serve-local:latest mkdocs/ && docker run --rm -v ${PWD}:/docs mkdocs-serve-local:latest build --strict",
4343
"typedocs-extensions-api": "yarn run typedoc src/extensions/extension-api.ts",
4444
"version-checkout": "cat package.json | jq '.version' -r | xargs printf \"release/v%s\" | xargs git checkout -b",
4545
"version-commit": "cat package.json | jq '.version' -r | xargs printf \"release v%s\" | git commit --no-edit -s -F -",

0 commit comments

Comments
 (0)