forked from quay/claircore
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: move injecturls helper to dedicated package
Signed-off-by: Hank Donnay <[email protected]>
- Loading branch information
Showing
3 changed files
with
11 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,8 @@ | ||
Here's various codebase conventions that don't have dedicated pages: | ||
|
||
- URLs | ||
URLs in code should be annotated with a `//doc:url` directive comment. See the | ||
the `docs/injecturls.go` file for documentation on how the preprocessor works. | ||
The list of keywords isn't an allowlist, so an invocation like the following | ||
should list the ones actually used in the documentation: | ||
|
||
git grep injecturls -- :/docs/*.md | ||
URLs in code should be annotated with a `//doc:url` directive comment. See | ||
the the `internal/cmd/mdbook-injecturls` command for documentation on how the | ||
preprocessor works. The list of keywords isn't an allowlist, so an invocation | ||
like the following should list the ones actually used in the documentation | ||
using a command like `git grep injecturls -- :/docs/*.md`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters