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

            Activity

            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.
            danielbeck Daniel Beck made changes -
            Epic Link JENKINS-33810 [ 169285 ]
            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: