8000 [doc] Support doc links in release notes · pmd/pmd@8aa7b5f · GitHub
[go: up one dir, main page]

Skip to content

Commit 8aa7b5f

Browse files
committed
[doc] Support doc links in release notes
Use an existing page as an example due to DeadLinksChecker
1 parent 9df4fdf commit 8aa7b5f

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

do-release.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -258,8 +258,8 @@ keywords: changelog, release notes
258258
259259
{% if is_release_notes_processor %}
260260
{% comment %}
261-
This allows to use links like [Page]({{ basedir }}pmd_devdocs_page.html) that work both in the release notes
262-
on GitHub (as an absolute url) and on the rendered documentation page (as a relative url).
261+
This allows to use links e.g. [Basic CLI usage]({{ basedir }}pmd_userdocs_installation.html) that work both
262+
in the release notes on GitHub (as an absolute url) and on the rendered documentation page (as a relative url).
263263
{% endcomment %}
264264
{% capture baseurl %}https://docs.pmd-code.org/pmd-doc-{{ site.pmd.version }}/{% endcapture %}
265265
{% else %}

docs/pages/pmd/projectdocs/committers/releasing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -344,8 +344,8 @@ keywords: changelog, release notes
344344

345345
{% if is_release_notes_processor %}
346346
{% comment %}
347-
This allows to use links like [Page]({{ basedir }}pmd_devdocs_page.html) that work both in the release notes
348-
on GitHub (as an absolute url) and on the rendered documentation page (as a relative url).
347+
This allows to use links e.g. [Basic CLI usage]({{ basedir }}pmd_userdocs_installation.html) that work both
348+
in the release notes on GitHub (as an absolute url) and on the rendered documentation page (as a relative url).
349349
{% endcomment %}
350350
{% capture baseurl %}https://docs.pmd-code.org/pmd-doc-{{ site.pmd.version }}/{% endcapture %}
351351
{% else %}

0 commit comments

Comments
 (0)
0