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

All UI fields in core Jenkins should have English documentation

    XMLWordPrintable

    Details

    • Similar Issues:

      Description

      I installed Jenkins 2.0 alpha-2, and noted that — even with no plugins installed — there are a lot of UI fields that have no inline help. Some of it wasn't well written.

      Ideally, every single field should have inline help in English (as a start), and the help text should be unambiguous, and grammatically correct.

      These are the areas, in order of importance I'd like to initially look at:

      • Freestyle Job Config
      • Manage Jenkins
      • Configure System
      • Agent configuration
      • Configure Global Security
      • New Item page (perhaps)

      As each item alone can be fairly large, and time-consuming, I'm going to submit them as separate PRs.

        Attachments

          Issue Links

          is related to

          Task - A task that needs to be done. JENKINS-33366 All UI fields in recommended plugins for Jenkins 2.0 should have English documentation

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Open
          links to

          Web Link PR #2101

            Activity

            Ascending order - Click to sort in descending order
            orrc Christopher Orr created issue -
            orrc Christopher Orr made changes -
            Field Original Value New Value
            Link This issue is related to JENKINS-33366 [ JENKINS-33366 ]
            orrc Christopher Orr made changes -
            Labels 2.0 2.0 user-experience
            orrc Christopher Orr made changes -
            Remote Link This issue links to "PR #2101 (Web Link)" [ 14050 ]
            kohsuke Kohsuke Kawaguchi made changes -
            Labels 2.0 user-experience 2.0 2.0-planned user-experience
            orrc Christopher Orr made changes -
            Status Open [ 1 ] In Progress [ 3 ]
            orrc Christopher Orr made changes -
            Description I installed Jenkins 2.0 alpha-2, and noted that — even with no plugins installed — there are a lot of UI fields that have no inline help. Some of it wasn't well written.

            Ideally, every single field should inline help in English (as a start), and the help text should be unambiguous, and gramatically correct.             		I installed Jenkins 2.0 alpha-2, and noted that — even with no plugins installed — there are a lot of UI fields that have no inline help. Some of it wasn't well written.

            Ideally, every single field should have inline help in English (as a start), and the help text should be unambiguous, and grammatically correct.
            orrc Christopher Orr made changes -
            Description I installed Jenkins 2.0 alpha-2, and noted that — even with no plugins installed — there are a lot of UI fields that have no inline help. Some of it wasn't well written.

            Ideally, every single field should have inline help in English (as a start), and the help text should be unambiguous, and grammatically correct.             		I installed Jenkins 2.0 alpha-2, and noted that — even with no plugins installed — there are a lot of UI fields that have no inline help. Some of it wasn't well written.

            Ideally, every single field should have inline help in English (as a start), and the help text should be unambiguous, and grammatically correct.

            From PR 2101, these are the areas, in order of importance I'd like to initially look at:
            * Freestyle Job Config
            * Manage Jenkins
            * Configure System
            * Agent configuration
            * Configure Global Security
            * New Item page (perhaps)

            As each item alone can be fairly large, and time-consuming, I'm going to submit them as separate PRs.
            orrc Christopher Orr made changes -
            Description I installed Jenkins 2.0 alpha-2, and noted that — even with no plugins installed — there are a lot of UI fields that have no inline help. Some of it wasn't well written.

            Ideally, every single field should have inline help in English (as a start), and the help text should be unambiguous, and grammatically correct.

            From PR 2101, these are the areas, in order of importance I'd like to initially look at:
            * Freestyle Job Config
            * Manage Jenkins
            * Configure System
            * Agent configuration
            * Configure Global Security
            * New Item page (perhaps)

            As each item alone can be fairly large, and time-consuming, I'm going to submit them as separate PRs.             		I installed Jenkins 2.0 alpha-2, and noted that — even with no plugins installed — there are a lot of UI fields that have no inline help. Some of it wasn't well written.

            Ideally, every single field should have inline help in English (as a start), and the help text should be unambiguous, and grammatically correct.

            These are the areas, in order of importance I'd like to initially look at:
            * Freestyle Job Config
            * Manage Jenkins
            * Configure System
            * Agent configuration
            * Configure Global Security
            * New Item page (perhaps)

            As each item alone can be fairly large, and time-consuming, I'm going to submit them as separate PRs.
            Hide
            Permalink
            orrc Christopher Orr added a comment -

            PR #2101 is linked above (for the Agent configuration page).

            That PR contains an overview of the changes that will be done for this ticket, and will link to the other PRs in the series.

            Show
            orrc Christopher Orr added a comment - PR #2101 is linked above (for the Agent configuration page). That PR contains an overview of the changes that will be done for this ticket, and will link to the other PRs in the series.
            danielbeck Daniel Beck made changes -
            Epic Link JENKINS-33810 [ 169285 ]
            Hide
            Permalink
            scm_issue_link SCM/JIRA link daemon added a comment -

            Code changed in jenkins
            User: Daniel Beck
            Path:
            core/src/main/resources/hudson/model/Messages.properties
            core/src/main/resources/hudson/model/Node/help-labelString.html
            core/src/main/resources/hudson/model/Node/help-name.html
            core/src/main/resources/hudson/model/Node/help-numExecutors.html
            core/src/main/resources/hudson/model/Slave/help-remoteFS.html
            core/src/main/resources/hudson/slaves/CommandLauncher/help.properties
            core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config.jelly
            core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_ca.properties
            core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_da.properties
            core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_de.properties
            core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_es.properties
            core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_es_AR.properties
            core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_fi.properties
            core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_fr.properties
            core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_he.properties
            core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_it.properties
            core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_ja.properties
            core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_ko.properties
            core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_lt.properties
            core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_nb_NO.properties
            core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_nl.properties
            core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_pl.properties
            core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_pt_BR.properties
            core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_pt_PT.properties
            core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_ru.properties
            core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_sk.properties
            core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_sv_SE.properties
            core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_zh_CN.properties
            core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_zh_TW.properties
            core/src/main/resources/hudson/slaves/JNLPLauncher/help.properties
            core/src/main/resources/hudson/slaves/Messages.properties
            core/src/main/resources/hudson/slaves/SimpleScheduledRetentionStrategy/config.jelly
            core/src/main/resources/hudson/slaves/SimpleScheduledRetentionStrategy/config_da.properties
            core/src/main/resources/hudson/slaves/SimpleScheduledRetentionStrategy/config_es.properties
            core/src/main/resources/hudson/slaves/SimpleScheduledRetentionStrategy/config_fr.properties
            core/src/main/resources/hudson/slaves/SimpleScheduledRetentionStrategy/config_ja.properties
            core/src/main/resources/hudson/slaves/SimpleScheduledRetentionStrategy/config_pt_BR.properties
            core/src/main/resources/hudson/slaves/SimpleScheduledRetentionStrategy/config_zh_TW.properties
            war/src/main/webapp/help/system-config/master-slave/availability.html
            war/src/main/webapp/help/system-config/master-slave/demand/idleDelay.html
            war/src/main/webapp/help/system-config/master-slave/demand/inDemandDelay.html
            war/src/main/webapp/help/system-config/master-slave/demand/keepUpWhenActive.html
            war/src/main/webapp/help/system-config/master-slave/description.html
            war/src/main/webapp/help/system-config/master-slave/usage.html
            war/src/main/webapp/help/system-config/nodeEnvironmentVariables.html
            http://jenkins-ci.org/commit/jenkins/125809823be5ab440d7eb5ccf4805c2ce5857227
            Log:
            Merge pull request #2101 from orrc/JENKINS-33364

            JENKINS-33364 Core documentation: Agent configuration

            Compare: https://github.com/jenkinsci/jenkins/compare/2bd03eebb6c7...125809823be5

            Show
            scm_issue_link SCM/JIRA link daemon added a comment - Code changed in jenkins User: Daniel Beck Path: core/src/main/resources/hudson/model/Messages.properties core/src/main/resources/hudson/model/Node/help-labelString.html core/src/main/resources/hudson/model/Node/help-name.html core/src/main/resources/hudson/model/Node/help-numExecutors.html core/src/main/resources/hudson/model/Slave/help-remoteFS.html core/src/main/resources/hudson/slaves/CommandLauncher/help.properties core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config.jelly core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_ca.properties core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_da.properties core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_de.properties core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_es.properties core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_es_AR.properties core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_fi.properties core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_fr.properties core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_he.properties core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_it.properties core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_ja.properties core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_ko.properties core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_lt.properties core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_nb_NO.properties core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_nl.properties core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_pl.properties core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_pt_BR.properties core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_pt_PT.properties core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_ru.properties core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_sk.properties core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_sv_SE.properties core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_zh_CN.properties core/src/main/resources/hudson/slaves/EnvironmentVariablesNodeProperty/config_zh_TW.properties core/src/main/resources/hudson/slaves/JNLPLauncher/help.properties core/src/main/resources/hudson/slaves/Messages.properties core/src/main/resources/hudson/slaves/SimpleScheduledRetentionStrategy/config.jelly core/src/main/resources/hudson/slaves/SimpleScheduledRetentionStrategy/config_da.properties core/src/main/resources/hudson/slaves/SimpleScheduledRetentionStrategy/config_es.properties core/src/main/resources/hudson/slaves/SimpleScheduledRetentionStrategy/config_fr.properties core/src/main/resources/hudson/slaves/SimpleScheduledRetentionStrategy/config_ja.properties core/src/main/resources/hudson/slaves/SimpleScheduledRetentionStrategy/config_pt_BR.properties core/src/main/resources/hudson/slaves/SimpleScheduledRetentionStrategy/config_zh_TW.properties war/src/main/webapp/help/system-config/master-slave/availability.html war/src/main/webapp/help/system-config/master-slave/demand/idleDelay.html war/src/main/webapp/help/system-config/master-slave/demand/inDemandDelay.html war/src/main/webapp/help/system-config/master-slave/demand/keepUpWhenActive.html war/src/main/webapp/help/system-config/master-slave/description.html war/src/main/webapp/help/system-config/master-slave/usage.html war/src/main/webapp/help/system-config/nodeEnvironmentVariables.html http://jenkins-ci.org/commit/jenkins/125809823be5ab440d7eb5ccf4805c2ce5857227 Log: Merge pull request #2101 from orrc/ JENKINS-33364 JENKINS-33364 Core documentation: Agent configuration Compare: https://github.com/jenkinsci/jenkins/compare/2bd03eebb6c7...125809823be5
            Hide
            Permalink
            scm_issue_link SCM/JIRA link daemon added a comment -

            Code changed in jenkins
            User: Daniel Beck
            Path:
            core/src/main/resources/jenkins/model/Jenkins/help-rawBuildsDir.html
            core/src/main/resources/jenkins/model/Jenkins/help-rawWorkspaceDir.html
            war/src/main/webapp/help/system-config/homeDirectory.html
            war/src/main/webapp/help/system-config/systemMessage.html
            http://jenkins-ci.org/commit/jenkins/0db4bc2a6327246ba98e65380b645977dc0a5a61
            Log:
            Merge pull request #2136 from orrc/JENKINS-33364_configure-system

            JENKINS-33364 Core documentation: Configure System page

            Compare: https://github.com/jenkinsci/jenkins/compare/125809823be5...0db4bc2a6327

            Show
            scm_issue_link SCM/JIRA link daemon added a comment - Code changed in jenkins User: Daniel Beck Path: core/src/main/resources/jenkins/model/Jenkins/help-rawBuildsDir.html core/src/main/resources/jenkins/model/Jenkins/help-rawWorkspaceDir.html war/src/main/webapp/help/system-config/homeDirectory.html war/src/main/webapp/help/system-config/systemMessage.html http://jenkins-ci.org/commit/jenkins/0db4bc2a6327246ba98e65380b645977dc0a5a61 Log: Merge pull request #2136 from orrc/ JENKINS-33364 _configure-system JENKINS-33364 Core documentation: Configure System page Compare: https://github.com/jenkinsci/jenkins/compare/125809823be5...0db4bc2a6327
            Hide
            Permalink
            scm_issue_link SCM/JIRA link daemon added a comment -

            Code changed in jenkins
            User: Daniel Beck
            Path:
            core/src/main/resources/hudson/model/AbstractItem/help-slaveAffinity.html
            core/src/main/resources/hudson/model/AbstractProject/help-concurrentBuild.html
            core/src/main/resources/hudson/model/AbstractProject/help-label.html
            core/src/main/resources/hudson/model/Messages.properties
            core/src/main/resources/hudson/model/Messages_en_GB.properties
            core/src/main/resources/hudson/model/Messages_it.properties
            core/src/main/resources/hudson/model/ParametersDefinitionProperty/help.html
            core/src/main/resources/jenkins/model/BuildDiscarderProperty/help.html
            core/src/main/resources/jenkins/model/GlobalQuietPeriodConfiguration/help-quietPeriod.html
            core/src/main/resources/jenkins/model/Messages.properties
            core/src/main/resources/lib/hudson/project/config-disableBuild.jelly
            core/src/main/resources/lib/hudson/project/config-disableBuild_bg.properties
            core/src/main/resources/lib/hudson/project/config-disableBuild_da.properties
            core/src/main/resources/lib/hudson/project/config-disableBuild_de.properties
            core/src/main/resources/lib/hudson/project/config-disableBuild_es.properties
            core/src/main/resources/lib/hudson/project/config-disableBuild_fr.properties
            core/src/main/resources/lib/hudson/project/config-disableBuild_he.properties
            core/src/main/resources/lib/hudson/project/config-disableBuild_hu.properties
            core/src/main/resources/lib/hudson/project/config-disableBuild_it.properties
            core/src/main/resources/lib/hudson/project/config-disableBuild_ja.properties
            core/src/main/resources/lib/hudson/project/config-disableBuild_ko.properties
            core/src/main/resources/lib/hudson/project/config-disableBuild_lt.properties
            core/src/main/resources/lib/hudson/project/config-disableBuild_nb_NO.properties
            core/src/main/resources/lib/hudson/project/config-disableBuild_nl.properties
            core/src/main/resources/lib/hudson/project/config-disableBuild_pl.properties
            core/src/main/resources/lib/hudson/project/config-disableBuild_pt_BR.properties
            core/src/main/resources/lib/hudson/project/config-disableBuild_ro.properties
            core/src/main/resources/lib/hudson/project/config-disableBuild_ru.properties
            core/src/main/resources/lib/hudson/project/config-disableBuild_sk.properties
            core/src/main/resources/lib/hudson/project/config-disableBuild_sv_SE.properties
            core/src/main/resources/lib/hudson/project/config-disableBuild_tr.properties
            core/src/main/resources/lib/hudson/project/config-disableBuild_uk.properties
            core/src/main/resources/lib/hudson/project/config-disableBuild_zh_CN.properties
            core/src/main/resources/lib/hudson/project/config-disableBuild_zh_TW.properties
            war/src/main/webapp/help/project-config/disable.html
            war/src/main/webapp/help/project-config/scmCheckoutRetryCount.html
            http://jenkins-ci.org/commit/jenkins/25340e033b5dd27657803caab5dd60b33b67215c
            Log:
            Merge pull request #2137 from orrc/JENKINS-33364_freestyle-config

            JENKINS-33364 Core documentation: Freestyle project config

            Compare: https://github.com/jenkinsci/jenkins/compare/4cb3f4eb27c1...25340e033b5d

            Show
            scm_issue_link SCM/JIRA link daemon added a comment - Code changed in jenkins User: Daniel Beck Path: core/src/main/resources/hudson/model/AbstractItem/help-slaveAffinity.html core/src/main/resources/hudson/model/AbstractProject/help-concurrentBuild.html core/src/main/resources/hudson/model/AbstractProject/help-label.html core/src/main/resources/hudson/model/Messages.properties core/src/main/resources/hudson/model/Messages_en_GB.properties core/src/main/resources/hudson/model/Messages_it.properties core/src/main/resources/hudson/model/ParametersDefinitionProperty/help.html core/src/main/resources/jenkins/model/BuildDiscarderProperty/help.html core/src/main/resources/jenkins/model/GlobalQuietPeriodConfiguration/help-quietPeriod.html core/src/main/resources/jenkins/model/Messages.properties core/src/main/resources/lib/hudson/project/config-disableBuild.jelly core/src/main/resources/lib/hudson/project/config-disableBuild_bg.properties core/src/main/resources/lib/hudson/project/config-disableBuild_da.properties core/src/main/resources/lib/hudson/project/config-disableBuild_de.properties core/src/main/resources/lib/hudson/project/config-disableBuild_es.properties core/src/main/resources/lib/hudson/project/config-disableBuild_fr.properties core/src/main/resources/lib/hudson/project/config-disableBuild_he.properties core/src/main/resources/lib/hudson/project/config-disableBuild_hu.properties core/src/main/resources/lib/hudson/project/config-disableBuild_it.properties core/src/main/resources/lib/hudson/project/config-disableBuild_ja.properties core/src/main/resources/lib/hudson/project/config-disableBuild_ko.properties core/src/main/resources/lib/hudson/project/config-disableBuild_lt.properties core/src/main/resources/lib/hudson/project/config-disableBuild_nb_NO.properties core/src/main/resources/lib/hudson/project/config-disableBuild_nl.properties core/src/main/resources/lib/hudson/project/config-disableBuild_pl.properties core/src/main/resources/lib/hudson/project/config-disableBuild_pt_BR.properties core/src/main/resources/lib/hudson/project/config-disableBuild_ro.properties core/src/main/resources/lib/hudson/project/config-disableBuild_ru.properties core/src/main/resources/lib/hudson/project/config-disableBuild_sk.properties core/src/main/resources/lib/hudson/project/config-disableBuild_sv_SE.properties core/src/main/resources/lib/hudson/project/config-disableBuild_tr.properties core/src/main/resources/lib/hudson/project/config-disableBuild_uk.properties core/src/main/resources/lib/hudson/project/config-disableBuild_zh_CN.properties core/src/main/resources/lib/hudson/project/config-disableBuild_zh_TW.properties war/src/main/webapp/help/project-config/disable.html war/src/main/webapp/help/project-config/scmCheckoutRetryCount.html http://jenkins-ci.org/commit/jenkins/25340e033b5dd27657803caab5dd60b33b67215c Log: Merge pull request #2137 from orrc/ JENKINS-33364 _freestyle-config JENKINS-33364 Core documentation: Freestyle project config Compare: https://github.com/jenkinsci/jenkins/compare/4cb3f4eb27c1...25340e033b5d
            danielbeck Daniel Beck made changes -
            Epic Link JENKINS-33810 [ 169285 ]
            danielbeck Daniel Beck made changes -
            Labels 2.0 2.0-planned user-experience 2.0 user-experience
            rtyler R. Tyler Croy made changes -
            Workflow JNJira [ 169277 ] JNJira + In-Review [ 185696 ]
            orrc Christopher Orr made changes -
            Status In Progress [ 3 ] Open [ 1 ]
            orrc Christopher Orr made changes -
            Assignee Christopher Orr [ orrc ]

              People

              Assignee:
              Unassigned Unassigned
              Reporter:
              orrc Christopher Orr
              Votes:
              1 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated: