🌱 Add warning about links without a path #424
Conversation
metal3-io-bot
added
the
size/XS
Signed-off-by: Peppi-Lotta <peppi-lotta.saari@est.tech>
peppi-lotta
force-pushed
the
peppi-lotta/warning-about-links-with-empty-path
branch
from
132e41e
to
06faeb2
Compare
| @@ -1,6 +1,6 @@ | |||
| # Metal3 Project | |||
|
|
|||
| <!-- markdownlint-disable no-empty-links --> | |||
| [comment]: After adding the releasetag preprocessor the build fails with output "thread 'main' panicked at '', src/utils/fs.rs:45:10" if there are links with empty paths. | |||
There was a problem hiding this comment.
I don't think we need the comment. It is not normal to have empty links, no "explanation" required 🙂
There was a problem hiding this comment.
In the case of mdbook Draft Chapters (see point 6. in docs) is a feature that is supposed to work. Draft Chapters are basically links that don't have a path and when the preprocessor was added those stopped working. I added the warning because the links are not working in this file as the mdbook documentation says the should. It's kind of an exception of an exception.
There was a problem hiding this comment.
I see! Thanks for the explanation!
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: lentzi90 The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
metal3-io-bot
added
the
approved
To avoid future confusion: add a warning about empty links and add empty link check back.
There is an open issue about this now with mdbook: rust-lang/mdBook#2369