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

Clean up step help

    XMLWordPrintable

Details

    Description

      Somebody needs to go through Snippet Generator to review every known Workflow step, checking that:

      • its display name is comprehensible and follows a consistent format
      • it has an inline help block (help.html next to config.jelly) describing the purpose of the step
      • all attributes have help blocks (help-attrName.html) unless the meaning of the attribute is immediately obvious from its title and form control

      Attachments

        Issue Links

          Activity

            Code changed in jenkins
            User: Antonio Muñiz
            Path:
            support/src/main/java/org/jenkinsci/plugins/workflow/support/steps/input/InputStep.java
            support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/input/InputStep/help-id.html
            support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/input/InputStep/help.html
            http://jenkins-ci.org/commit/pipeline-input-step-plugin/a16465233e6dca2a3a4cb0ab82160cf37ea610f9
            Log:
            JENKINS-30086 Steps help and decription clean up

            Originally-Committed-As: 0b1c5dcd53f0a456ef243a360ad36f6f23cc8bbe

            scm_issue_link SCM/JIRA link daemon added a comment - Code changed in jenkins User: Antonio Muñiz Path: support/src/main/java/org/jenkinsci/plugins/workflow/support/steps/input/InputStep.java support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/input/InputStep/help-id.html support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/input/InputStep/help.html http://jenkins-ci.org/commit/pipeline-input-step-plugin/a16465233e6dca2a3a4cb0ab82160cf37ea610f9 Log: JENKINS-30086 Steps help and decription clean up Originally-Committed-As: 0b1c5dcd53f0a456ef243a360ad36f6f23cc8bbe

            Code changed in jenkins
            User: Antonio Muñiz
            Path:
            support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/input/InputStep/help-message.html
            support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/input/InputStep/help-parameters.html
            http://jenkins-ci.org/commit/pipeline-input-step-plugin/7e940f2e3deb6724e5353f7d32a8248e04385d46
            Log:
            JENKINS-30086 Incorporate content from #203

            Originally-Committed-As: c357b475b60b4a97fea26046c5457aa60d8f6182

            scm_issue_link SCM/JIRA link daemon added a comment - Code changed in jenkins User: Antonio Muñiz Path: support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/input/InputStep/help-message.html support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/input/InputStep/help-parameters.html http://jenkins-ci.org/commit/pipeline-input-step-plugin/7e940f2e3deb6724e5353f7d32a8248e04385d46 Log: JENKINS-30086 Incorporate content from #203 Originally-Committed-As: c357b475b60b4a97fea26046c5457aa60d8f6182

            Code changed in jenkins
            User: Antonio Muñiz
            Path:
            support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/StageStep/help-concurrency.html
            support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/StageStep/help.html
            http://jenkins-ci.org/commit/pipeline-stage-step-plugin/eadc69018722953ba49485035d7ae72250bd67c6
            Log:
            JENKINS-30086 Steps help and decription clean up

            Originally-Committed-As: 0b1c5dcd53f0a456ef243a360ad36f6f23cc8bbe

            scm_issue_link SCM/JIRA link daemon added a comment - Code changed in jenkins User: Antonio Muñiz Path: support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/StageStep/help-concurrency.html support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/StageStep/help.html http://jenkins-ci.org/commit/pipeline-stage-step-plugin/eadc69018722953ba49485035d7ae72250bd67c6 Log: JENKINS-30086 Steps help and decription clean up Originally-Committed-As: 0b1c5dcd53f0a456ef243a360ad36f6f23cc8bbe

            Code changed in jenkins
            User: Antonio Muñiz
            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/steps/LoadStep/help-path.html
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/steps/LoadStep/help.html
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/steps/ParallelStep/config.jelly
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/steps/ParallelStep/help.html
            http://jenkins-ci.org/commit/workflow-cps-plugin/7e9d43243bc2404b00f9e63445cfbb9489386a03
            Log:
            JENKINS-30086 Steps help and decription clean up

            Originally-Committed-As: 0b1c5dcd53f0a456ef243a360ad36f6f23cc8bbe

            scm_issue_link SCM/JIRA link daemon added a comment - Code changed in jenkins User: Antonio Muñiz 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/steps/LoadStep/help-path.html cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/steps/LoadStep/help.html cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/steps/ParallelStep/config.jelly cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/steps/ParallelStep/help.html http://jenkins-ci.org/commit/workflow-cps-plugin/7e9d43243bc2404b00f9e63445cfbb9489386a03 Log: JENKINS-30086 Steps help and decription clean up Originally-Committed-As: 0b1c5dcd53f0a456ef243a360ad36f6f23cc8bbe

            Code changed in jenkins
            User: Jesse Glick
            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/steps/LoadStep/help-path.html
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/steps/LoadStep/help.html
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/steps/ParallelStep/config.jelly
            cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/steps/ParallelStep/help.html
            http://jenkins-ci.org/commit/workflow-cps-plugin/84da6eb12f5aa74b2639531b2c0fc3b4612cca7f
            Log:
            Merge pull request #211 from amuniz/JENKINS-30086

            JENKINS-30086 Steps help and description clean up
            Originally-Committed-As: 71a89610d8ce4597fc2a95705301820d15c76501

            scm_issue_link SCM/JIRA link daemon added a comment - Code changed in jenkins User: Jesse Glick 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/steps/LoadStep/help-path.html cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/steps/LoadStep/help.html cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/steps/ParallelStep/config.jelly cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/steps/ParallelStep/help.html http://jenkins-ci.org/commit/workflow-cps-plugin/84da6eb12f5aa74b2639531b2c0fc3b4612cca7f Log: Merge pull request #211 from amuniz/ JENKINS-30086 JENKINS-30086 Steps help and description clean up Originally-Committed-As: 71a89610d8ce4597fc2a95705301820d15c76501

            People

              amuniz Antonio Muñiz
              jglick Jesse Glick
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: