Uploaded image for project: 'Moodle'
  1. Moodle
  2. MDL-72146

Administration > Development > UI Component Library menu item should always exist

    • Icon: Improvement Improvement
    • Resolution: Unresolved
    • Icon: Minor Minor
    • None
    • 4.0, 4.2.2
    • Themes, Usability
    • MOODLE_400_STABLE, MOODLE_402_STABLE
    • Hide

      Before testing, ensure the admin/tool/componentlibrary/docs directory is not present

      1. Login as admin
      2. Navigate to Development in site administration
      3. Confirm UI Component library link is present
      4. Click UI Component library
      5. Confirm help page loads with explanation of usage/generation of documentation
      6. Generate documentation with grunt, e.g.:

        $ nvm use
        $ ./node_modules/.bin/grunt componentlibrary
        

      7. Navigate to Development > UI Component library in site administration
      8. Confirm generated component library documentation is shown
      Show
      Before testing, ensure the admin/tool/componentlibrary/docs directory is not present Login as admin Navigate to Development in site administration Confirm UI Component library link is present Click UI Component library Confirm help page loads with explanation of usage/generation of documentation Generate documentation with grunt , e.g.: $ nvm use $ ./node_modules/.bin/grunt componentlibrary Navigate to Development > UI Component library in site administration Confirm generated component library documentation is shown

      The new UI library is reeaally awesome! Like super duper good (thanks basbrands )

      But it has been crippled right out of the gate because it isn't easily discovered by dev's. It has made the same mistake as xhprof / tideways in that the admin menu item only appears when certain conditions are met.

      I think this is a critical mistake and we should fix it asap - the menu item should always appear so a curious dev can see it and clicks on it to learn what it is, and then if the conditions are not met they should get a clear message with instructions or a link to instructions on how to get it working.

      I'd love to even go one step further and get some sort of HQ policy around this type of dev tool (ideally all sorts of stuff not just dev tools) so that all admin menu items like this are never conditional so they get a foot in the door with devs, and it gets picked up in peer review.

      (p.s. Did I mention how great this tool is??)

            pholden Paul Holden
            brendanheywood Brendan Heywood
            Brendan Heywood Brendan Heywood
            Votes:
            2 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:

                Estimated:
                Original Estimate - 0 minutes
                0m
                Remaining:
                Remaining Estimate - 0 minutes
                0m
                Logged:
                Time Spent - 1 hour
                1h

                  Error rendering 'clockify-timesheets-time-tracking-reports:timer-sidebar'. Please contact your Jira administrators.