clarify that once a page has undergone migration, redirection from th…

…e old wiki page is necessary. (#7204) * Added a section of Update parent POM page * minor wording changed * added on how to use checkUrl in Form validation * removed extra part * changes have been made to clarify that once a page has undergone migration, redirection from the old wiki page is necessary. * removed unwanted part * minor changes * Update content/doc/developer/publishing/wiki-page.adoc * rephrased * Update content/doc/developer/publishing/wiki-page.adoc Co-authored-by: Mark Waite <[email protected]> * add redirect configuration to steps * Improve link to table of contents example --------- Co-authored-by: Bruno Verachten <[email protected]> Co-authored-by: Kevin Martens <[email protected]> Co-authored-by: Mark Waite <[email protected]>
jenkins-infra · Apr 18, 2024 · bb099fd · bb099fd
1 parent 297dcc9
commit bb099fd
Showing 1 changed file with 3 additions and 3 deletions.
diff --git 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.