diff --git a/content/doc/developer/publishing/wiki-page.adoc b/content/doc/developer/publishing/wiki-page.adoc index dd2b53ce58a5..dc6fa7f72a94 100644 --- a/content/doc/developer/publishing/wiki-page.adoc +++ b/content/doc/developer/publishing/wiki-page.adoc @@ -46,11 +46,11 @@ If you cannot identify migrated pages, this creates a major technical obstacle i . Review/edit the migrated file formatting. ** If the document includes "Table of contents", remove this section in Markdown - or replace it using the `:toc:` macros in Asciidoc (link:https://raw.githubusercontent.com/jenkinsci/.github/master/.github/release-drafter.adoc[example]). + or replace it using the `:toc:` macros in Asciidoc (link:https://github.com/jenkinsci/.github/blob/master/.github/release-drafter.adoc?plain=1[example]). ** If the source Wiki page includes code blocks, they will need to be manually converted. Pandoc exports them as tables. -. Extract changelogs to a separate file. -** It is recommended to extract changelogs to a separate `CHANGELOG.md` file in the repository root. +. Extract changelogs to a separate file or create GitHub releases for past versions. +** If you create a changelog file, extract the changelogs to a separate `CHANGELOG.md` file in the repository root. It allows tools like Dependabot to read changelog summaries. ** Use versions as headers. Changelogs in Wiki often include release dates, but it is better to keep them in the text below the header.