Commit e800038
committed
fix(build-docs): create extra README.md symlinks for READMEs linked from CONTRIBUTING
CONTRIBUTING.md links to `check-plugins/example/README.md` and
`check-plugins/php-fpm-status/README.md` as the reference READMEs
for structure and detail depth. Both links need to resolve in two
different rendering contexts:
- On GitHub, where the link is relative to CONTRIBUTING.md at
the repo root and points at the real README file in the plugin
subdirectory.
- On the mkdocs-rendered docs site, where the link is resolved
against the docs_dir and therefore needs a doc file at
`docs/check-plugins/<name>/README.md`.
`tools/build-docs` already created the extra symlink for `example`
but not for `php-fpm-status`, which made mkdocs strict-mode fail on
the docs-build CI job with:
WARNING - Doc file 'contributing.md' contains a link
'check-plugins/php-fpm-status/README.md', but the target is
not found among documentation files.
Aborted with 1 warnings in strict mode!
Generalise the special case: extract a
`README_LINKED_FROM_CONTRIBUTING` list at the top of build-docs,
create an extra symlink under `docs/check-plugins/<name>/README.md`
for every entry, and add every entry to `not_in_nav` so mkdocs
does not complain about a doc file that is outside the main
navigation. Adding a new CONTRIBUTING.md reference now means
appending one name to the list.
`example` stays excluded from the main nav because it is a
template, not a plugin; `php-fpm-status` still appears in the nav
via its normal `check-plugins/php-fpm-status.md` docs page and
only gets the extra README.md symlink on top of that.1 parent dfaada9 commit e800038
1 file changed
+32
-9
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
16 | 16 | | |
17 | 17 | | |
18 | 18 | | |
19 | | - | |
| 19 | + | |
20 | 20 | | |
21 | 21 | | |
22 | 22 | | |
23 | 23 | | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
24 | 43 | | |
25 | 44 | | |
26 | 45 | | |
| |||
122 | 141 | | |
123 | 142 | | |
124 | 143 | | |
125 | | - | |
| 144 | + | |
| 145 | + | |
126 | 146 | | |
127 | 147 | | |
128 | 148 | | |
| |||
193 | 213 | | |
194 | 214 | | |
195 | 215 | | |
196 | | - | |
197 | | - | |
198 | | - | |
199 | | - | |
200 | | - | |
201 | | - | |
202 | | - | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
203 | 226 | | |
204 | 227 | | |
205 | 228 | | |
| |||
0 commit comments