You are viewing a plain text version of this content. The canonical link for it is here.
Posted to log4j-dev@logging.apache.org by "Remko Popma (JIRA)" <ji...@apache.org> on 2013/04/08 09:01:19 UTC
[jira] [Closed] (LOG4J2-199) Site navigation
[ https://issues.apache.org/jira/browse/LOG4J2-199?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Remko Popma closed LOG4J2-199.
------------------------------
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.
> Site navigation
> ---------------
>
> Key: LOG4J2-199
> URL: https://issues.apache.org/jira/browse/LOG4J2-199
> Project: Log4j 2
> Issue Type: Bug
> Components: Documentation
> Affects Versions: 2.0-beta5
> Reporter: Remko Popma
> Assignee: Ralph Goers
> Fix For: 2.0-beta5
>
> Attachments: LOG4J2-199-site-navi-improvement.patch
>
>
> 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.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: log4j-dev-unsubscribe@logging.apache.org
For additional commands, e-mail: log4j-dev-help@logging.apache.org