Move documentation from README to gh-pages

[rantoniuk]

Scope

• [x] create a more user-friendly, gh-pages based documentation based on the current README and with more (a lot) of pipeline DSL examples. Use templating-agent-plugin as the inspiration.
• [x] (try to) keep the new docs visible on both sides, gh-pages and plugins.jenkins.io/jira

Out of scope

No response

[MarkEWaite]

It would be nice if the documentation also continued to be visible at https://plugins.jenkins.io/jira/ since that is a common location for Jenkins plugin documentation.

[rantoniuk]

It would be nice indeed and that's the goal. I just queried whole JenkinsCI for a summary of all plugins that are using gh-pages and I see the majority isn't visible on plugins.jenkins.io though:

• jelly: https://github.com/jenkinsci/jelly (Homepage: http://jenkinsci.github.io/jelly/)
• json-lib: https://github.com/jenkinsci/json-lib (Homepage: https://jenkinsci.github.io/json-lib/)
• lib-access-modifier: https://github.com/jenkinsci/lib-access-modifier (Homepage: )
• maven-hpi-plugin: https://github.com/jenkinsci/maven-hpi-plugin (Homepage: http://jenkinsci.github.io/maven-hpi-plugin/)
• android-emulator-plugin: https://github.com/jenkinsci/android-emulator-plugin (Homepage: https://plugins.jenkins.io/android-emulator/)
• bulk-builder-plugin: https://github.com/jenkinsci/bulk-builder-plugin (Homepage: https://plugins.jenkins.io/bulk-builder/)
• jira-plugin: https://github.com/jenkinsci/jira-plugin (Homepage: https://plugins.jenkins.io/jira)
• performance-plugin: https://github.com/jenkinsci/performance-plugin (Homepage: https://plugins.jenkins.io/performance/)
• dropdown-viewstabbar-plugin: https://github.com/jenkinsci/dropdown-viewstabbar-plugin (Homepage: https://plugins.jenkins.io/dropdown-viewstabbar-plugin/)
• dumpinfo-buildwrapper-plugin: https://github.com/jenkinsci/dumpinfo-buildwrapper-plugin (Homepage: https://plugins.jenkins.io/dumpinfo-buildwrapper-plugin/)
• lib-jira-api: https://github.com/jenkinsci/lib-jira-api (Homepage: https://jenkins.io)
• periodicbackup-plugin: https://github.com/jenkinsci/periodicbackup-plugin (Homepage: https://plugins.jenkins.io/periodicbackup/)
• darcs-plugin: https://github.com/jenkinsci/darcs-plugin (Homepage: http://jenkinsci.github.com/darcs-plugin/)
• stapler-maven-plugin: https://github.com/jenkinsci/stapler-maven-plugin (Homepage: http://jenkinsci.github.io/stapler-maven-plugin/)
• stapler: https://github.com/jenkinsci/stapler (Homepage: )
• license-maven-plugin: https://github.com/jenkinsci/license-maven-plugin (Homepage: http://jenkinsci.github.io/license-maven-plugin/)
• persistent-build-queue-plugin: https://github.com/jenkinsci/persistent-build-queue-plugin (Homepage: https://plugins.jenkins.io/persistent-build-queue-plugin/)
• winp: https://github.com/jenkinsci/winp (Homepage: http://winp.kohsuke.org/)
• jcaptcha-plugin: https://github.com/jenkinsci/jcaptcha-plugin (Homepage: https://plugins.jenkins.io/jcaptcha-plugin/)
• jellydoc-maven-plugin: https://github.com/jenkinsci/jellydoc-maven-plugin (Homepage: http://jenkinsci.github.io/jellydoc-maven-plugin/)
• config-autorefresh-plugin: https://github.com/jenkinsci/config-autorefresh-plugin (Homepage: https://wiki.jenkins-ci.org/display/JENKINS/Config+AutoRefresh+Plugin)
• keyhole: https://github.com/jenkinsci/keyhole (Homepage: )
• job-import-plugin: https://github.com/jenkinsci/job-import-plugin (Homepage: https://plugins.jenkins.io/job-import-plugin/)
• chrome-frame-plugin: https://github.com/jenkinsci/chrome-frame-plugin (Homepage: https://wiki.jenkins-ci.org/display/JENKINS/Chrome+Frame+Plugin)
• lib-file-leak-detector: https://github.com/jenkinsci/lib-file-leak-detector (Homepage: http://file-leak-detector.kohsuke.org/)
• groovy-sandbox: https://github.com/jenkinsci/groovy-sandbox (Homepage: )
• whitesource-plugin: https://github.com/jenkinsci/whitesource-plugin (Homepage: None)
• job-dsl-plugin: https://github.com/jenkinsci/job-dsl-plugin (Homepage: https://plugins.jenkins.io/job-dsl/)
• java-client-api: https://github.com/jenkinsci/java-client-api (Homepage: None)
• maven-release-cascade-plugin: https://github.com/jenkinsci/maven-release-cascade-plugin (Homepage: https://github.com/barchart/barchart-jenkins-cascade-plugin/wiki)
• rhnpush-plugin: https://github.com/jenkinsci/rhnpush-plugin (Homepage: https://plugins.jenkins.io/rhnpush-plugin/)
• rally-plugin: https://github.com/jenkinsci/rally-plugin (Homepage: http://jenkinsci.github.io/rally-plugin/)
• mesos-plugin: https://github.com/jenkinsci/mesos-plugin (Homepage: https://plugins.jenkins.io/mesos/)
• transifex-plugin: https://github.com/jenkinsci/transifex-plugin (Homepage: https://plugins.jenkins.io/transifex/)
• doony-plugin: https://github.com/jenkinsci/doony-plugin (Homepage: http://doony.org)
• pushbullet-plugin: https://github.com/jenkinsci/pushbullet-plugin (Homepage: None)
• matrix-groovy-execution-strategy-plugin: https://github.com/jenkinsci/matrix-groovy-execution-strategy-plugin (Homepage: https://plugins.jenkins.io/matrix-groovy-execution-strategy/)
• violation-comments-to-stash-plugin: https://github.com/jenkinsci/violation-comments-to-stash-plugin (Homepage: https://plugins.jenkins.io/violation-comments-to-stash)
• bootstraped-multi-test-results-report-plugin: https://github.com/jenkinsci/bootstraped-multi-test-results-report-plugin (Homepage: https://plugins.jenkins.io/bootstraped-multi-test-results-report/)
• violation-comments-to-github-plugin: https://github.com/jenkinsci/violation-comments-to-github-plugin (Homepage: https://plugins.jenkins.io/violation-comments-to-github)
• jenkins-design-language: https://github.com/jenkinsci/jenkins-design-language (Homepage: https://jenkinsci.github.io/jenkins-design-language)
• pubsub-light-plugin: https://github.com/jenkinsci/pubsub-light-plugin (Homepage: https://plugins.jenkins.io/pubsub-light/)
• blueocean-acceptance-test: https://github.com/jenkinsci/blueocean-acceptance-test (Homepage: )
• jmdns-fork: https://github.com/jenkinsci/jmdns-fork (Homepage: http://www.jmdns.org)
• dingtalk-plugin: https://github.com/jenkinsci/dingtalk-plugin (Homepage: https://jenkinsci.github.io/dingtalk-plugin/)
• pipeline-multibranch-defaults-plugin: https://github.com/jenkinsci/pipeline-multibranch-defaults-plugin (Homepage: https://plugins.jenkins.io/pipeline-multibranch-defaults/)
• js-storage: https://github.com/jenkinsci/js-storage (Homepage: None)
• js-logging: https://github.com/jenkinsci/js-logging (Homepage: None)
• jira-steps-plugin: https://github.com/jenkinsci/jira-steps-plugin (Homepage: https://jenkinsci.github.io/jira-steps-plugin)
• ftp-rename-plugin: https://github.com/jenkinsci/ftp-rename-plugin (Homepage: https://plugins.jenkins.io/ftp-rename/)
• js-preferences: https://github.com/jenkinsci/js-preferences (Homepage: None)
• sonar-quality-gates-plugin: https://github.com/jenkinsci/sonar-quality-gates-plugin (Homepage: https://plugins.jenkins.io/sonar-quality-gates/)
• radargun-reporting-plugin: https://github.com/jenkinsci/radargun-reporting-plugin (Homepage: https://plugins.jenkins.io/radargun-reporting/)
• badge-plugin: https://github.com/jenkinsci/badge-plugin (Homepage: https://plugins.jenkins.io/badge/)
• kubernetes-credentials-provider-plugin: https://github.com/jenkinsci/kubernetes-credentials-provider-plugin (Homepage: https://jenkinsci.github.io/kubernetes-credentials-provider-plugin/)
• neuvector-vulnerability-scanner-plugin: https://github.com/jenkinsci/neuvector-vulnerability-scanner-plugin (Homepage: https://plugins.jenkins.io/neuvector-vulnerability-scanner/)
• ssh-steps-plugin: https://github.com/jenkinsci/ssh-steps-plugin (Homepage: https://plugins.jenkins.io/ssh-steps)
• bitbucket-push-and-pull-request-plugin: https://github.com/jenkinsci/bitbucket-push-and-pull-request-plugin (Homepage: https://plugins.jenkins.io/bitbucket-push-and-pull-request)
• kubernetes-operator: https://github.com/jenkinsci/kubernetes-operator (Homepage: https://jenkinsci.github.io/kubernetes-operator)
• templating-engine-plugin: https://github.com/jenkinsci/templating-engine-plugin (Homepage: https://jenkinsci.github.io/templating-engine-plugin/)
• ibm-g11n-pipeline-plugin: https://github.com/jenkinsci/ibm-g11n-pipeline-plugin (Homepage: None)
• aws-secrets-manager-credentials-provider-plugin: https://github.com/jenkinsci/aws-secrets-manager-credentials-provider-plugin (Homepage: https://plugins.jenkins.io/aws-secrets-manager-credentials-provider/)
• test-results-aggregator-plugin: https://github.com/jenkinsci/test-results-aggregator-plugin (Homepage: https://plugins.jenkins.io/test-results-aggregator/)
• synopsys-polaris-plugin: https://github.com/jenkinsci/synopsys-polaris-plugin (Homepage: https://plugins.jenkins.io/synopsys-polaris/)
• simple-queue-plugin: https://github.com/jenkinsci/simple-queue-plugin (Homepage: https://plugins.jenkins.io/simple-queue/)
• helm-charts: https://github.com/jenkinsci/helm-charts (Homepage: https://artifacthub.io/packages/helm/jenkinsci/jenkins)
• jfr-action-doc: https://github.com/jenkinsci/jfr-action-doc (Homepage: https://jenkinsci.github.io/jfr-action-doc/)
• provar-automation-plugin: https://github.com/jenkinsci/provar-automation-plugin (Homepage: https://plugins.jenkins.io/provar-automation/)

I randomly looked through the list and found one that is visible on both sides: https://jenkinsci.github.io/performance-plugin/ https://plugins.jenkins.io/performance/

but I don't see anything special for docs in repository-permissions-updater/plugin-performance.yml.

Anyway, I'll modify the issue description to put that in scope

[MarkEWaite]

The source URL of the documentation that is published to plugins.jenkins.io is read from the pom file of the plugin, like this example. The performance plugin uses that technique to have a high level documentation page on plugins.jenkins.io with more detailed information available by clicking a link from that high level documentation page. The Job DSL plugin uses the same technique.