Commit a718b26
doc: fence command examples in release guide
Put the command examples for finding and replacing the `REPLACEME`
tags into code fences so that they are more easily copiable when
viewing the guide in the GitHub web UI.
PR-URL: #39544
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Beth Griggs <bgriggs@redhat.com>
Reviewed-By: Danielle Adams <adamzdanielle@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>1 parent 42669bb commit a718b26
1 file changed
Lines changed: 8 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -345,10 +345,14 @@ accordingly by removing the bold styling from the previous release. | |||
| 345 | 345 | If this release includes new APIs then it is necessary to document that they | |
| 346 | 346 | were first added in this version. The relevant commits should already include | |
| 347 | 347 | `REPLACEME` tags as per the example in the | |
| 348 | - [docs README](../../tools/doc/README.md). Check for these tags with `grep | ||
| 349 | - REPLACEME doc/api/*.md`, and substitute this node version with `sed -i | ||
| 350 | - "s/REPLACEME/$VERSION/g" doc/api/*.md` or `perl -pi -e "s/REPLACEME/$VERSION/g" | ||
| 351 | - doc/api/*.md`. | ||
| 348 | + [docs README](../../tools/doc/README.md). Check for these tags with | ||
| 349 | + ```console | ||
| 350 | + grep REPLACEME doc/api/*.md | ||
| 351 | + ``` | ||
| 352 | + and substitute this node version with | ||
| 353 | + ```console | ||
| 354 | + sed -i "s/REPLACEME/$VERSION/g" doc/api/*.md` or `perl -pi -e "s/REPLACEME/$VERSION/g" doc/api/*.md | ||
| 355 | + ``` | ||
| 352 | 356 | ||
| 353 | 357 | `$VERSION` should be prefixed with a `v`. | |
| 354 | 358 | ||
0 commit comments