Uploaded image for project: 'Jenkins'
  1. Jenkins
  2. JENKINS-32133

Polish and expose auto-generated Workflow step documentation

    XMLWordPrintable

Details

    • Improvement
    • Status: Resolved (View Workflow)
    • Minor
    • Resolution: Fixed
    • pipeline
    • None

    Description

      The first work for JENKINS-26126 added the internals (and a proof of concept HTML output) for introspecting Workflow steps and returning information about them, such as arguments, help docs, etc. That HTML needs to be cleaned up into a presentable form and, along with the GDSL and DSLD that'll come from JENKINS-26126, it needs to be exposed like the /cli endpoint on a Jenkins master with Workflow installed.

      Attachments

        Issue Links

          Activity

            abayer Andrew Bayer added a comment -

            Once we have a look and feel down for the HTML, I'm thinking of doing an endpoint for exposing it in Markdown and/or Confluence wiki format, for easy auto-import into jenkins.io and wiki.jenkins-ci.org...importing either from ci.jenkins-ci.org or a new Jenkins master we set up solely for the purpose of serving the auto-generated docs.

            abayer Andrew Bayer added a comment - Once we have a look and feel down for the HTML, I'm thinking of doing an endpoint for exposing it in Markdown and/or Confluence wiki format, for easy auto-import into jenkins.io and wiki.jenkins-ci.org...importing either from ci.jenkins-ci.org or a new Jenkins master we set up solely for the purpose of serving the auto-generated docs.

            Code changed in jenkins
            User: Andrew Bayer
            Path:
            cps/src/main/java/org/jenkinsci/plugins/workflow/cps/Snippetizer.java
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/block.jelly
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslHelp.groovy
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslReference.groovy
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslReferenceContent.groovy
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dsld.groovy
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/gdsl.groovy
            cps/src/test/java/org/jenkinsci/plugins/workflow/cps/SnippetizerTest.java
            step-api/src/main/java/org/jenkinsci/plugins/workflow/structs/DescribableHelper.java
            http://jenkins-ci.org/commit/workflow-plugin/ccedde44b53dde20b3360b4402e028de4069742a
            Log:
            [JENKINS-26126, JENKINS-32133] GDSL, DSLD, improved reference docs

            Squashed down to one commit. Added GDSL, DSLD and Groovy view-driven
            HTML reference docs for Workflow DSL, integrated into the job config
            UI, also able to be fetched directly from standard URLs.

            scm_issue_link SCM/JIRA link daemon added a comment - Code changed in jenkins User: Andrew Bayer Path: cps/src/main/java/org/jenkinsci/plugins/workflow/cps/Snippetizer.java cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/block.jelly cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslHelp.groovy cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslReference.groovy cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslReferenceContent.groovy cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dsld.groovy cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/gdsl.groovy cps/src/test/java/org/jenkinsci/plugins/workflow/cps/SnippetizerTest.java step-api/src/main/java/org/jenkinsci/plugins/workflow/structs/DescribableHelper.java http://jenkins-ci.org/commit/workflow-plugin/ccedde44b53dde20b3360b4402e028de4069742a Log: [JENKINS-26126, JENKINS-32133] GDSL, DSLD, improved reference docs Squashed down to one commit. Added GDSL, DSLD and Groovy view-driven HTML reference docs for Workflow DSL, integrated into the job config UI, also able to be fetched directly from standard URLs.

            Code changed in jenkins
            User: gusreiber
            Path:
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/EnvActionImpl/Binder/help.jelly
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/css/workflow.css
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslHelp.groovy
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslReference.groovy
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslReferenceContent.groovy
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/js/workflow.js
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/workflow.css
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/workflow.js
            http://jenkins-ci.org/commit/workflow-plugin/7d1fdbdff78fd55bff325051617b3457f5629dad
            Log:
            JENKINS-32133 styling issues for DSL reference help

            scm_issue_link SCM/JIRA link daemon added a comment - Code changed in jenkins User: gusreiber Path: cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/EnvActionImpl/Binder/help.jelly cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/css/workflow.css cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslHelp.groovy cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslReference.groovy cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslReferenceContent.groovy cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/js/workflow.js cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/workflow.css cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/workflow.js http://jenkins-ci.org/commit/workflow-plugin/7d1fdbdff78fd55bff325051617b3457f5629dad Log: JENKINS-32133 styling issues for DSL reference help

            Code changed in jenkins
            User: Jesse Glick
            Path:
            CHANGES.md
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/EnvActionImpl/Binder/help.jelly
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslHelp.groovy
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslReference.groovy
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslReferenceContent.groovy
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/workflow.css
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/workflow.js
            http://jenkins-ci.org/commit/workflow-plugin/71559f35cb73ecf7cfa880045b58a4317693b347
            Log:
            JENKINS-32133 Merged #320.

            scm_issue_link SCM/JIRA link daemon added a comment - Code changed in jenkins User: Jesse Glick Path: CHANGES.md cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/EnvActionImpl/Binder/help.jelly cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslHelp.groovy cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslReference.groovy cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslReferenceContent.groovy cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/workflow.css cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/workflow.js http://jenkins-ci.org/commit/workflow-plugin/71559f35cb73ecf7cfa880045b58a4317693b347 Log: JENKINS-32133 Merged #320.

            Code changed in jenkins
            User: Andrew Bayer
            Path:
            cps/src/main/java/org/jenkinsci/plugins/workflow/cps/Snippetizer.java
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/block.jelly
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslHelp.groovy
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslReference.groovy
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslReferenceContent.groovy
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dsld.groovy
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/gdsl.groovy
            cps/src/test/java/org/jenkinsci/plugins/workflow/cps/SnippetizerTest.java
            http://jenkins-ci.org/commit/workflow-cps-plugin/75df2410f755daa69c1005a19d46f4f14afe250c
            Log:
            [JENKINS-26126, JENKINS-32133] GDSL, DSLD, improved reference docs

            Squashed down to one commit. Added GDSL, DSLD and Groovy view-driven
            HTML reference docs for Workflow DSL, integrated into the job config
            UI, also able to be fetched directly from standard URLs.

            Originally-Committed-As: ccedde44b53dde20b3360b4402e028de4069742a

            scm_issue_link SCM/JIRA link daemon added a comment - Code changed in jenkins User: Andrew Bayer Path: cps/src/main/java/org/jenkinsci/plugins/workflow/cps/Snippetizer.java cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/block.jelly cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslHelp.groovy cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslReference.groovy cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslReferenceContent.groovy cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dsld.groovy cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/gdsl.groovy cps/src/test/java/org/jenkinsci/plugins/workflow/cps/SnippetizerTest.java http://jenkins-ci.org/commit/workflow-cps-plugin/75df2410f755daa69c1005a19d46f4f14afe250c Log: [JENKINS-26126, JENKINS-32133] GDSL, DSLD, improved reference docs Squashed down to one commit. Added GDSL, DSLD and Groovy view-driven HTML reference docs for Workflow DSL, integrated into the job config UI, also able to be fetched directly from standard URLs. Originally-Committed-As: ccedde44b53dde20b3360b4402e028de4069742a

            Code changed in jenkins
            User: gusreiber
            Path:
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/EnvActionImpl/Binder/help.jelly
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslHelp.groovy
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslReference.groovy
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslReferenceContent.groovy
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/workflow.css
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/workflow.js
            http://jenkins-ci.org/commit/workflow-cps-plugin/06956bcee3e51eaec9c94043b1e55e2abfc15d9a
            Log:
            JENKINS-32133 styling issues for DSL reference help

            Originally-Committed-As: 7d1fdbdff78fd55bff325051617b3457f5629dad

            scm_issue_link SCM/JIRA link daemon added a comment - Code changed in jenkins User: gusreiber Path: cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/EnvActionImpl/Binder/help.jelly cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslHelp.groovy cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslReference.groovy cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslReferenceContent.groovy cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/workflow.css cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/workflow.js http://jenkins-ci.org/commit/workflow-cps-plugin/06956bcee3e51eaec9c94043b1e55e2abfc15d9a Log: JENKINS-32133 styling issues for DSL reference help Originally-Committed-As: 7d1fdbdff78fd55bff325051617b3457f5629dad

            Code changed in jenkins
            User: Jesse Glick
            Path:
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/EnvActionImpl/Binder/help.jelly
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslHelp.groovy
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslReference.groovy
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslReferenceContent.groovy
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/workflow.css
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/workflow.js
            http://jenkins-ci.org/commit/workflow-cps-plugin/a0513e8e4738221cf41cbe9942074fdc936729b4
            Log:
            JENKINS-32133 Merged #320.

            Originally-Committed-As: 71559f35cb73ecf7cfa880045b58a4317693b347

            scm_issue_link SCM/JIRA link daemon added a comment - Code changed in jenkins User: Jesse Glick Path: cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/EnvActionImpl/Binder/help.jelly cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslHelp.groovy cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslReference.groovy cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/dslReferenceContent.groovy cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/workflow.css cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/workflow.js http://jenkins-ci.org/commit/workflow-cps-plugin/a0513e8e4738221cf41cbe9942074fdc936729b4 Log: JENKINS-32133 Merged #320. Originally-Committed-As: 71559f35cb73ecf7cfa880045b58a4317693b347

            People

              abayer Andrew Bayer
              abayer Andrew Bayer
              Votes:
              1 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: