sardell opened a new pull request #1460: METRON-2179: Make navigation in both 
UIs consistent
URL: https://github.com/apache/metron/pull/1460
 
 
   ## Contributor Comments
   READ FIRST: This Pull Request seems very large, but a majority of the line 
changes are in the auto-generated package-lock.json file. There are maybe a one 
or two hundred lines of code changes outside of that auto-generated file. Now, 
breathe a sigh of relief. :smile:
   
   Link to original JIRA ticket here: 
https://issues.apache.org/jira/browse/METRON-2179
   
   Currently, both UIs approach navigation in two different ways. This makes 
the interfaces seem inconsistent and can be confusing for new users. Both ways 
are also not collapsible. We also cannot navigate between both UIs (this was 
intentional in the original implementation, but feedback from users over time 
seems to indicate separating the personas is not necessarily beneficial).
   
   This is how the navigations currently look on master:
   
   ![Screen Shot 2019-07-11 at 11 42 38 
AM](https://user-images.githubusercontent.com/7304869/61040529-0b06d400-a3d1-11e9-9778-7d4c3f893659.png)
   
   ![Screen Shot 2019-07-11 at 11 42 50 
AM](https://user-images.githubusercontent.com/7304869/61040532-0c380100-a3d1-11e9-993d-03a5822ab178.png)
   
   
   In this PR, I added a collapsible sidebar navigation and removed the 
previous implemented navigations.
   
   ![Screen Shot 2019-07-11 at 10 18 17 
AM](https://user-images.githubusercontent.com/7304869/61035559-aeeb8200-a3c7-11e9-92b0-a701064c9c78.png)
   
   ![Screen Shot 2019-07-11 at 10 18 27 
AM](https://user-images.githubusercontent.com/7304869/61035570-b3179f80-a3c7-11e9-8847-6a2cc56cd773.png)
   
   In order to do this, I utilized the Angular-version of [Ant Design's 
component library](https://ng.ant.design/docs/introduce/en). I did this because 
bootstrap does not contain a collapsible side navigation like this, and Ant 
Design allowed me to quickly implement this feature.
   
   I also had to upgrade our version of Angular to the latest stable 7 release. 
Upgrading from 6 to 7 did not introduce any breaking changes.
   
   ## Testing
   
   Open either the Alerts or Management UI. A navigation should exist on the 
left-hand side of the screen (see above screenshots), and you should be able to 
minimize it by clicking on the arrow at the bottom of the menu. Besides 
navigating within the app, you should be able to navigate between both UIs.
   
   ## Pull Request Checklist
   
   Thank you for submitting a contribution to Apache Metron.  
   Please refer to our [Development 
Guidelines](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=61332235)
 for the complete guide to follow for contributions.  
   Please refer also to our [Build Verification 
Guidelines](https://cwiki.apache.org/confluence/display/METRON/Verifying+Builds?show-miniview)
 for complete smoke testing guides.  
   
   
   In order to streamline the review of the contribution we ask you follow 
these guidelines and ask you to double check the following:
   
   ### For all changes:
   - [ ] Is there a JIRA ticket associated with this PR? If not one needs to be 
created at [Metron 
Jira](https://issues.apache.org/jira/browse/METRON/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel).
   - [ ] Does your PR title start with METRON-XXXX where XXXX is the JIRA 
number you are trying to resolve? Pay particular attention to the hyphen "-" 
character.
   - [ ] Has your PR been rebased against the latest commit within the target 
branch (typically master)?
   
   
   ### For code changes:
   - [ ] Have you included steps to reproduce the behavior or problem that is 
being changed or addressed?
   - [ ] Have you included steps or a guide to how the change may be verified 
and tested manually?
   - [ ] Have you ensured that the full suite of tests and checks have been 
executed in the root metron folder via:
     ```
     mvn -q clean integration-test install && 
dev-utilities/build-utils/verify_licenses.sh 
     ```
   
   - [ ] Have you written or updated unit tests and or integration tests to 
verify your changes?
   - [ ] If adding new dependencies to the code, are these dependencies 
licensed in a way that is compatible for inclusion under [ASF 
2.0](http://www.apache.org/legal/resolved.html#category-a)?
   - [ ] Have you verified the basic functionality of the build by building and 
running locally with Vagrant full-dev environment or the equivalent?
   
   ### For documentation related changes:
   - [ ] Have you ensured that format looks appropriate for the output in which 
it is rendered by building and verifying the site-book? If not then run the 
following commands and the verify changes via 
`site-book/target/site/index.html`:
   
     ```
     cd site-book
     mvn site
     ```
   
   - [ ] Have you ensured that any documentation diagrams have been updated, 
along with their source files, using [draw.io](https://www.draw.io/)? See 
[Metron Development 
Guidelines](https://cwiki.apache.org/confluence/display/METRON/Development+Guidelines)
 for instructions.
   
   #### Note:
   Please ensure that once the PR is submitted, you check travis-ci for build 
issues and submit an update to your PR as soon as possible.
   It is also recommended that [travis-ci](https://travis-ci.org) is set up for 
your personal repository such that your branches are built there before 
submitting a pull request.
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


With regards,
Apache Git Services

Reply via email to