Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 2.0-beta5
    • Fix Version/s: 2.0-beta5
    • Component/s: Documentation
    • Labels:
      None

      Description

      Does anyone else find the site navigation for the Components confusing?

      In the left-hand side navigation panel, if you click on one of the Component links (like API, Implementation, ... Log4J Web) it takes you to a page where that component is not highlighted. Instead, Project Information > About (under Project Documentation) is highlighted. It took me a while to figure out that this is like a nested "project" site.

      I think it would be helpful if for all "nested project" pages, the selected Component would be highlighted as well as the selected Project Documentation link.

      So if you click on API, in the resulting page both the API link and the Project Information > About link would be highlighted in the left-hand navigation panel. Then if you choose for example Project Information > Dependencies, the API link would still be highlighted together with the Dependencies link.

      I think this would help users understand where they are in the site.

      Patch to follow soon.

        Issue Links

          Activity

          Hide
          Remko Popma added a comment -

          Verified, looks good.

          Show
          Remko Popma added a comment - Verified, looks good.
          Hide
          Ralph Goers added a comment -

          Patch applied in revision 1470168.

          Show
          Ralph Goers added a comment - Patch applied in revision 1470168.
          Hide
          Remko Popma added a comment -

          Please find attached file LOG4J2-199-components-v2.patch.
          This is a clean patch updated for the recent changes to trunk (especially the removal of the log4j-async module).
          Otherwise no changes.

          I'll remove the old file LOG4J2-199-components.patch to avoid confusion.

          Show
          Remko Popma added a comment - Please find attached file LOG4J2-199 -components-v2.patch. This is a clean patch updated for the recent changes to trunk (especially the removal of the log4j-async module). Otherwise no changes. I'll remove the old file LOG4J2-199 -components.patch to avoid confusion.
          Hide
          Remko Popma added a comment -

          LOG4J2-199-components.patch contains one change in the log4j-async module.
          The patch for LOG4J2-208 removes the log4j-async module, so if possible apply this patch before LOG4J2-208.

          Show
          Remko Popma added a comment - LOG4J2-199 -components.patch contains one change in the log4j-async module. The patch for LOG4J2-208 removes the log4j-async module, so if possible apply this patch before LOG4J2-208 .
          Hide
          Remko Popma added a comment -

          Attachment LOG4J2-199-components.patch:
          clicking a component now adds a Component Documentation section to the left-hand menu in addition to the (overall) Project Information section.

          Component Documentation avoids the word "Project" and only contains component-specific pages.

          Show
          Remko Popma added a comment - Attachment LOG4J2-199 -components.patch: clicking a component now adds a Component Documentation section to the left-hand menu in addition to the (overall) Project Information section. Component Documentation avoids the word "Project" and only contains component-specific pages.
          Hide
          Remko Popma added a comment -

          Verified. Thanks.

          I think this is an improvement but I agree more can be done.

          After clicking on a component you are in a different (sub) site but users cannot see that because both the top nav bar and the left-hand side menu look almost identical.

          • clicking a component currently replaces the Project Information section with the component's Project Documentation section
          • the component's Project Documentation section is a mixture of component-specific pages and overall project pages. Specifically, Project Team, Mailing List, Issue Tracking, Project License and Source Repository are overall project pages that are not component-specific.

          Instead, it may be better if clicking a component would:

          • Add a new Component Documentation section between the Components and the overall Project Information section. The Project Information section stays in the menu and links to overall project pages.
          • This new Component Documentation section should only contain component-specific links
          • The word "Project ..." should be avoided in the new component documentation section. Use "Component" instead. The selected component is highlighted in the menu so it is clear which component we are on.

          I'll submit a patch when I have something working for this.

          Show
          Remko Popma added a comment - Verified. Thanks. I think this is an improvement but I agree more can be done. After clicking on a component you are in a different (sub) site but users cannot see that because both the top nav bar and the left-hand side menu look almost identical. clicking a component currently replaces the Project Information section with the component's Project Documentation section the component's Project Documentation section is a mixture of component-specific pages and overall project pages. Specifically, Project Team, Mailing List, Issue Tracking, Project License and Source Repository are overall project pages that are not component-specific. Instead, it may be better if clicking a component would: Add a new Component Documentation section between the Components and the overall Project Information section. The Project Information section stays in the menu and links to overall project pages. This new Component Documentation section should only contain component-specific links The word "Project ..." should be avoided in the new component documentation section. Use "Component" instead. The selected component is highlighted in the menu so it is clear which component we are on. I'll submit a patch when I have something working for this.
          Hide
          Ralph Goers added a comment -

          Patch applied in revision 1465468. Please verify and close.

          However, I don't think this is going to be the end of the issue. At one point I had the heading change to say "API Documentation" or "Core Documentation" as users clicked on the component and people were still confused. I think it got changed to just "Project Documentation" when the skin was last updated.

          Show
          Ralph Goers added a comment - Patch applied in revision 1465468. Please verify and close. However, I don't think this is going to be the end of the issue. At one point I had the heading change to say "API Documentation" or "Core Documentation" as users clicked on the component and people were still confused. I think it got changed to just "Project Documentation" when the skin was last updated.
          Hide
          Remko Popma added a comment -

          Attached file LOG4J2-199-site-navi-improvement.patch modifies the site.vm script to highlight both the selected Component and its current Project Information page.

          Show
          Remko Popma added a comment - Attached file LOG4J2-199 -site-navi-improvement.patch modifies the site.vm script to highlight both the selected Component and its current Project Information page.

            People

            • Assignee:
              Ralph Goers
              Reporter:
              Remko Popma
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development