Migrate the plugin documentation from Wiki to GitHub

[oleg-nenashev]

We have recently introduced support of GitHub documentation on the Jenkins Plugin Site. See this Developer thread for the announcement.

Jenkins users seeking documentation will have a better user experience on plugins.jenkins.io than they do on wiki.jenkins.io. At the same time, maintainers can follow the documentation-as-code approach and make documentation changes a part of pull requests. Documentation changes will be reviewed as part of pull requests and documentation contributors will be recognized, especially when combined with Release Drafter.

Once documentation is moved, the plugin metadata needs to be updated to point to GitHub: documentation URL in the project file (guide) . Then the change will be applied after the release.

P.S: In Jenkins project we track the documentation migration as one of the Hacktoberfest featured project: https://jenkins.io/events/hacktoberfest/ . Please feel free to put hacktoberfest and good first issue label in this repo if you are interested to suggest it for external contributions

[KalleOlaviNiemitalo]

https://wiki.jenkins-ci.org/display/JENKINS/Sidebar+Link+Plugin and https://github.com/jenkins-infra/plugins-wiki-docs/tree/master/sidebar-link contain:

• A description of the features of the plugin. Pretty much the same thing is in README.md already.
• Change log. That's already in CHANGELOG.md.

pom.xml also contains the documentation URL:

sidebar-link-plugin/pom.xml

Line 13 in 345e07c

<url>https://github.com/jenkinsci/sidebar-link-plugin</url>

So, it looks like all the requested changes have been done already.

[KalleOlaviNiemitalo]

CHANGELOG.md does not cover the releases after 1.10 though, and they are not documented in GitHub releases either. If I understand correctly, the changes are as follows:

Version 2.1.0 (17-Feb-2022)

• Fix icon upload iframe in global config (PR JENKINS-55710, #28 - Fix icon upload iframe in global config #36, fixes Blocked iframe #28, fixes JENKINS-55710)

Version 2.0.2 (12-Feb-2022)

• Fix number hpi.forcompatibleSinceVersion (PR Fix number hpi.forcompatibleSinceVersion #38, fixes Update Center warns about Sidebar Link upgrade from 2.0.0 to 2.0.1 #37)

Version 2.0.1 (10-Feb-2022)

• Add warning about new version (PR Add warning about new version #33)
• Update messages (PR Update messages #34)

Version 2.0.0 (8-Feb-2022)

Versions 2.* cannot read settings saved by versions 1.*, nor vice versa.

• Remove Travis, add Jenkins badge (PR Remove Travis, add Jenkins badge #29)
• Remove outdated Codacy badge (PR Remove outdated Codacy badge #30)
• Tweaks to use of Java generics (PR Tweaks to use of Java generics #32)
• Adding JCasC support (PR [JENKINS-63149] - Adding JCasC support #25, fixes JENKINS-63149)

Version 1.12.1 (24-Oct-2021)

• Hacktoberfest docs-to-code migration (PR Hacktoberfest docs-to-code migration #27, mostly fixes Migrate the plugin documentation from Wiki to GitHub #21)

Version 1.12.0 (14-Mar-2021)

• Integrates with TravisCI (PR Integrates with TravisCI #15)
• Fixes broken link to badge (PR Fixes broken link to badge #16)
• Adds Codacy badge, removes reported issues (PR Adds Codacy badge, removes reported issues #18)
• Adds integration with Appveyor (PR Adds integration with Appveyor #19)
• Use HTTPS URLs in pom.xml (PR Use HTTPS URLs in pom.xml #20)
• Migrate to JDK 11 (PR Migrate to JDK 11 #24)

Version 1.11.0 (13-Feb-2019)

• Updates pom.xml, adds .gitignore, license (PR Updates pom.xml, adds .gitignore, license #12)
• Upgrades dependencies and JDK to version 8 (PR Upgrades dependencies and JDK to version 8 #13)
• Reformats code to Java standards (PR Reformats code to Java standards #14)

[KalleOlaviNiemitalo]

The README has been migrated and the CHANGELOG is up to date. The following GitHub integrations have not been done:

• Converting existing tags to GitHub releases with release notes, so that https://plugins.jenkins.io/sidebar-link/ will display the release notes
• Release Drafter
• Automated plugin release (continuous delivery); see also Update CHANGELOG.md for existing versions up to 2.1.0 #39 (comment)

@damianszczepanik, as the maintainer of the plugin, do you think those should be done? If so, should they be filed as separate issues or tracked in this issue?

[damianszczepanik]

Separate deliverable sounds like good idea.