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

All UI fields in core Jenkins 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 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.

          [JENKINS-33364] All UI fields in core Jenkins should have English documentation

          Christopher Orr created issue -
          Christopher Orr made changes -
          Link New: This issue is related to JENKINS-33366 [ JENKINS-33366 ]
          Christopher Orr made changes -
          Labels Original: 2.0 New: 2.0 user-experience
          Christopher Orr made changes -
          Remote Link New: This issue links to "PR #2101 (Web Link)" [ 14050 ]
          Kohsuke Kawaguchi made changes -
          Labels Original: 2.0 user-experience New: 2.0 2.0-planned user-experience
          Christopher Orr made changes -
          Status Original: Open [ 1 ] New: In Progress [ 3 ]
          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 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.
          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 have inline help in English (as a start), and the help text should be unambiguous, and grammatically correct.
          New: 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.
          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 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.
          New: 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.

          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.

          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.

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

              Created:
              Updated: