Merge branch 'master' into drivers-2922/uri-validation

.github/workflows/lint.yml

@@ -18,3 +18,15 @@ jobs:
  run: |
  pip install -U -q pre-commit
  pre-commit run --all-files --hook-stage manual
+
+ mkdocs:
+ runs-on: ubuntu-latest
+ timeout-minutes: 5
+
+ steps:
+ - uses: actions/checkout@v4
+ - uses: actions/setup-python@v4
+ - name: Setup dependencies
+ run: pip install -r source/requirements.txt
+ - name: Check docs
+ run: mkdocs build --strict

.gitignore

@@ -12,4 +12,5 @@ codereview.rc
 docs_build
 .pytest_cache
 node_modules
-package-lock.json
+package-lock.json
+site

.pre-commit-config.yaml

@@ -22,18 +22,6 @@ repos:
  args: ["--severity=error"]
  stages: [manual]
 
-- repo: local
- hooks:
- - id: generate-index
- name: generate-index
- entry: python3 scripts/generate_index.py
- language: system
- - id: check-anchors
- name: check-anchors
- types: [markdown]
- entry: bash scripts/check_anchors/check-anchors.sh
- language: node
-
 - repo: https://github.com/executablebooks/mdformat
  rev: 0.7.17
  hooks:
@@ -42,6 +30,18 @@ repos:
  additional_dependencies:
  [mdformat-gfm, mdformat-frontmatter, mdformat-footnote, mdformat-gfm-alerts]
 
+- repo: local
+ hooks:
+ - id: generate-index
+ name: generate-index
+ entry: python3 scripts/generate_index.py
+ language: system
+ - id: markdown-link-format-check
+ name: markdown-link-format-check
+ types: [markdown]
+ language: system
+ entry: python3 scripts/check_links.py
+
 - repo: https://github.com/tcort/markdown-link-check
  rev: v3.12.2
  hooks:

README.md

@@ -53,6 +53,10 @@ pip install mkdocs
 mkdocs serve
 ```
 
+To build the docs, use `mkdocs build`.
+
+In CI we verify that there are no warnings. To replicate locally, run `mkdocs build --strict`.
+
 ## Converting to JSON
 
 There are many YAML to JSON converters. There are even several converters called `yaml2json` in NPM. Alas, we are not

markdown_link_config.json

@@ -1,20 +1,8 @@
 {
  "ignorePatterns": [
- {
- "pattern": "^/source/server-discovery-and-monitoring/server-discovery-and-monitoring.rst#"
- },
  {
  "pattern": "^#"
  },
- {
- "pattern": "^../command-logging-and-monitoring/command-monitoring.rst#security"
- },
- {
- "pattern": "^logging/logging.rst#log-severity-levels"
- },
- {
- "pattern": "./enumerate-indexes.rst"
- },
  {
  "pattern": "^https://github.com/10gen/mongo-enterprise-modules"
  },
@@ -23,9 +11,6 @@
  },
  {
  "pattern": "cloudkms.googleapis.com"
- },
- {
- "pattern": "subtype6#intent-to-encrypt"
  }
  ]
 }

mkdocs.yml

@@ -4,5 +4,11 @@ nav:
  - 'index.md'
 markdown_extensions:
  - admonition
+ - toc:
+ permalink: 
 plugins:
- - gh-admonitions
+ - gh-admonitions
+validation:
+ absolute_links: warn 
+ unrecognized_links: warn
+ anchors: warn