Great news! On Tue, Sep 3, 2019 at 4:18 PM Oleg Nenashev <[email protected]> wrote: > > Dear all, > > We would like to announce support of GitHub README files as a documentation > source for plugins.jenkins.io. Some examples of the documentation from GitHub: > > https://plugins.jenkins.io/configuration-as-code > https://plugins.jenkins.io/mailer > https://plugins.jenkins.io/folder-auth > > Why? This is a long-anticipated feature, many plugins have already moved > their documentation to GitHub. By supporting such source in plugin site we > provide good user experience to Jenkins users who look for documentation. At > the same time, plugin maintainers now can follow the documentation-as-code > approach and make documentation changes a part of the pull requests. It also > gives an opportunity to review the documentation changes and to add > documentation contributor recognition, especially if the story is combined > with Release Drafter. > > The story is tracked as WEBSITE-406 which is a part of the wider subproject > for supporting GitHub-based documentation in the Jenkins plugin site and > update managers (WEBSITE-637 under the umbrella of the Documentation SIG). > Later steps include support showing changelogs from GitHub releases, showing > plugin logos. > > Current state. GitHub documentation source support is a new feature, early > adopters are welcome to try it out. There might be defects we have not > discovered yet, and it is yet to be seen how it scales. The implementation > uses a GitHub application token to get a high API limit, and we also use > https://www.jsdelivr.com/ as a CDN for images. If you hit any issue, please > file a ticket in the WEBSITE-637 EPIC. > > How to enable GitHub documentation for your plugin? > > Move documentation from Wiki to GitHub README if you have not done it yet. > Both Markdown and Asciidoc are supported > Change the <url> field in pom.xml so that it points to GitHub (example PR) > Release a new plugin version > Wait for few hours till the change gets propagated > > Code? If you want to see the changes under the hood of the plugin site, > please see the links in Plugin Site API v1.6.0 (yes, now we have changelog > there!). So far we needed only the backend changes to add the feature, but > there will be front-end changes for other stories inside the EPIC. If you are > a Java or JavaScript/React developer, any contributions will be appreciated. > The plugin site is really easy to develop. > > Credits. I would like to thank Zbynek Konecny and Olivier Vernin for their > work on these stories. They have done the vast majority of changes to make it > happen. > > If you have any questions/feedback, please do not hesitate to answer in this > thread or to join the https://gitter.im/jenkinsci/docs chat. We will also > have sync-ups and demos at the regular Documentation SIG meetings. > > Best regards, > Oleg Nenashev > > -- > You received this message because you are subscribed to the Google Groups > "Jenkins Developers" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to [email protected]. > To view this discussion on the web visit > https://groups.google.com/d/msgid/jenkinsci-dev/CAPfivLAKuSVR7cO-W%2BfXqe2K0BBsm8qa-38Arb-9Do32UHNDXg%40mail.gmail.com.
-- Matt Sicker Senior Software Engineer, CloudBees -- You received this message because you are subscribed to the Google Groups "Jenkins Developers" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/CAEot4ox_VA5Uyy2XN%3Df75xC07Z_CY3%3Dxjm3cXRjA_b1vdE59PA%40mail.gmail.com.
