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

All UI fields in recommended plugins for Jenkins 2.0 should have English documentation

    • Icon: Task Task
    • Resolution: Unresolved
    • Icon: Minor Minor
    • core
    • Jenkins 2.0-alpha-2

      I installed Jenkins 2.0 alpha-2, and installed the recommended plugins, and noticed that there are a lot of UI fields that have no inline help.

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

      I will try to concentrate on the most popular plugins, as listed by Daniel's spreadsheet, and keep track of PRs from this ticket.
      Though of course anyone who wants to help is welcome

          [JENKINS-33366] All UI fields in recommended plugins for Jenkins 2.0 should have English documentation

          Christopher Orr created issue -
          Christopher Orr made changes -
          Link New: This issue is related to JENKINS-33364 [ JENKINS-33364 ]
          Christopher Orr made changes -
          Labels Original: 2.0 New: 2.0 user-experience
          Christopher Orr made changes -
          Description Original: 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.
          New: I installed Jenkins 2.0 alpha-2, and installed the recommended plugins, and noticed that there are a lot of UI fields that have no inline help.

          Similarly, some plugins still refer to "slaves" rather than "agents" — prominently, this includes the "New item" text of the Pipeline plugin.

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

          I will try to concentrate on the most popular plugins, as listed by [Daniel's spreadsheet|https://docs.google.com/spreadsheets/d/1TKziW5oEfX9NYAPrZkz-wXPt5s-zG-znIB5-Jwt3tmw/edit], and keep track of PRs from this ticket.
          Though of course anyone who wants to help is welcome :)
          Christopher Orr made changes -
          Description Original: I installed Jenkins 2.0 alpha-2, and installed the recommended plugins, and noticed that there are a lot of UI fields that have no inline help.

          Similarly, some plugins still refer to "slaves" rather than "agents" — prominently, this includes the "New item" text of the Pipeline plugin.

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

          I will try to concentrate on the most popular plugins, as listed by [Daniel's spreadsheet|https://docs.google.com/spreadsheets/d/1TKziW5oEfX9NYAPrZkz-wXPt5s-zG-znIB5-Jwt3tmw/edit], and keep track of PRs from this ticket.
          Though of course anyone who wants to help is welcome :)
          New: I installed Jenkins 2.0 alpha-2, and installed the recommended plugins, and noticed that there are a lot of UI fields that have no inline help.

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

          I will try to concentrate on the most popular plugins, as listed by [Daniel's spreadsheet|https://docs.google.com/spreadsheets/d/1TKziW5oEfX9NYAPrZkz-wXPt5s-zG-znIB5-Jwt3tmw/edit], and keep track of PRs from this ticket.
          Though of course anyone who wants to help is welcome :)
          Christopher Orr made changes -
          Link New: This issue is related to JENKINS-33369 [ JENKINS-33369 ]
          Kohsuke Kawaguchi made changes -
          Labels Original: 2.0 user-experience New: 2.0 2.0-planned user-experience

          I'm thinking the probability of this happening for the initial 2.0 release is pretty low...

          Christopher Orr added a comment - I'm thinking the probability of this happening for the initial 2.0 release is pretty low...
          Daniel Beck made changes -
          Labels Original: 2.0 2.0-planned user-experience New: 2.0 user-experience
          R. Tyler Croy made changes -
          Workflow Original: JNJira [ 169279 ] New: JNJira + In-Review [ 183430 ]

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

              Created:
              Updated: