• Type: Task
• Resolution: Unresolved
• Priority: Minor
• Component/s: core
• Labels:

  • 2.0
  • user-experience
• Environment:

  Jenkins 2.0-alpha-2

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

Christopher Orr created issue - 2016-03-07 22:41

Christopher Orr made changes - 2016-03-07 22:42

Link

New: This issue is related to JENKINS-33364 [ JENKINS-33364 ]

Christopher Orr made changes - 2016-03-07 23:23

Labels

Original: 2.0

New: 2.0 user-experience

Christopher Orr made changes - 2016-03-07 23:23

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 - 2016-03-08 00:05

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 - 2016-03-08 00:05

Link

New: This issue is related to JENKINS-33369 [ JENKINS-33369 ]

Kohsuke Kawaguchi made changes - 2016-03-14 22:46

Labels

Original: 2.0 user-experience

New: 2.0 2.0-planned user-experience

Daniel Beck made changes - 2016-03-24 15:11

Labels

Original: 2.0 2.0-planned user-experience

New: 2.0 user-experience

R. Tyler Croy made changes - 2016-07-25 23:52

Workflow

Original: JNJira [ 169279 ]

New: JNJira + In-Review [ 183430 ]

Christopher Orr made changes - 2021-01-16 14:12

Assignee

Original: Christopher Orr [ orrc ]