[MXNET-293] Navigation updates by kpmurali · Pull Request #10449 · apache/mxnet

kpmurali · 2018-04-07T01:14:45Z

Description

Updates to the website navigation to be in line with the new organization.

Changes

[ x ] Add ONNX to Docs
[ x ] Remove Gluon
[ x ] Move Github to Community
[ x ] Rename Gluon Model Zoo --> Model Zoo

1. Add ONNX to Docs 2. Move Github to Community 3. ename Gluon Model Zoo to Model Zoo

marcoabreu · 2018-04-07T13:52:51Z

          <a href="#" class="main-nav-link dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="true">Community <span class="caret"></span></a>
          <ul id="package-dropdown-menu-community" class="dropdown-menu navbar-menu">
+            <li><a class="main-nav-link" href="http://discuss.mxnet.io">Forum</a></li>
+            <li><a class="main-nav-link" href="https://github.com/dmlc/mxnet">Github</a></li>


please change to apache/incubator-mxnet

kpmurali · 2018-04-09T18:27:25Z

Updated the GitHub community URL. Please review http://54.210.6.225/

anirudh2290 · 2018-04-09T18:37:26Z

-          <a href="#" class="main-nav-link dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="true">Gluon <span class="caret"></span></a>
-          <ul id="package-dropdown-menu" class="dropdown-menu navbar-menu">
-            <li><a class="main-nav-link" href="{{url_root}}gluon/index.html">About</a></li>
-            <li><a class="main-nav-link" href="http://gluon.mxnet.io">Tutorials</a></li>


Why remove gluon ? No easy way for users to get to the gluon book now ?

You can get to the Gluon book from the tutorials page. Plus @thomelane will be moving that link on the tutorials page above the fold, so it will be easier to see.

anirudh2290 · 2018-04-10T04:54:47Z

@piiswrong can we merge this ?

piiswrong · 2018-04-10T18:44:07Z

Not sure about making Gluon less visible. What's the reason?

aaronmarkham · 2018-04-10T20:56:21Z

Gluon is a Python API and being categorized at the top level was leading to some confusion. Also, the subsequent links were not that helpful. One led to an old About page that had outdated info. The other immediately led off-site, which was a jarring UX. Neither actual lead to the API, docs, or tutorials.
Gluon will be give top real estate and priority in tutorials and other information, so its visibility will not be diminished moving forward. It's positioning vis-a-vis the other ways of interacting with MXNet will be a little more clear.

kpmurali · 2018-04-13T03:13:47Z

So can this be merged now?

anirudh2290 · 2018-04-17T20:53:40Z

@piiswrong the gluon crash course has been added to the front page as part of this PR: #10570 . Do you think we still need the Gluon link at the top level or can it be moved to tutorials ?

piiswrong · 2018-04-17T21:23:19Z

I think think there should be a easy way to access the gluon book since the tutorial page doesn't look very good.

mli · 2018-04-17T21:28:22Z

CI preview is available at http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-10449/4/index.html

In general, I feel this PR make the frontpage less well organized. We should have a proposal and reviewed by marketing experts, instead of patch it from time to time.

mli · 2018-04-17T21:29:50Z

@@ -1,5 +1,5 @@
 var searchBox = $("#search-input-wrap");
-var TITLE = ['/install/', '/gluon/' , '/api/', '/docs/', '/github/', '/community/', ];


removing gluon results an empty space on the navbar, and make people harder to find gluon.

see http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-10449/4/index.html

thomelane · 2018-04-17T21:49:32Z

@mli @piiswrong So separately I've been rewriting the tutorials page, and a link to 'The Straight Dope' will be made clear in the Python tutorials section. In addition to this the relevant pages of the 'The Straight Dope' will be added to the tutorial list as their own items. So I don't think there's any concern that users will not be able to find the content from the 'The Straight Dope'.

I'm also working to combine the contents of the Gluon About page with the API Docs introductions for the Python and Gluon package, and then reference this from a number of sources including FAQ.

aaronmarkham · 2018-04-18T00:02:44Z

What if we put Gluon in the Docs menu? It would be highlighted there, and provide a link to the API docs page. This page will have the info Thom is mentioning, plus links to TSD, 60 min crash course, tutorials on site, etc.

srochel · 2018-04-18T14:06:07Z

The PR is blocking the 1.2 RC creation. Can we keep Gluon in navigation bar until we have a complete proposal in place, reviewed and agreed? We should not have this discussions past feature freeze.

kpmurali · 2018-04-18T17:36:21Z

Ok, I will add Gluon and its links back to the Navbar unless anyone has any objections.

aaronmarkham · 2018-04-18T18:21:42Z

@srochel - this was intended to go out after 1.2 RC, but when ONNX was removed from the home page to make room for the 60-min crash course, we lost the only way to find ONNX info. It wouldn't even be in the nav, so that's why I asked for the overall nav update to be included as well.

kpmurali · 2018-04-18T18:23:36Z

I have added Gluon back to the navbar. Please review @aaronmarkham @mli @piiswrong @srochel

anirudh2290 · 2018-04-18T20:38:53Z

@piiswrong @mli gluon has been added back. Is this good to merge ?

* Changes for SIM AWSDBUX-19875 1. Add ONNX to Docs 2. Move Github to Community 3. ename Gluon Model Zoo to Model Zoo * Removing Gluon from the Navbar and correcting the link for ONNX * Re-ordering the elements in the Navbar for SIM AWSDBUX-19875 * In the navbar, changing the Github URL to to apache/incubator-mxnet * Removing gluon and github from navbar.js * Adding Gluon back to the Navbar

kpmurali added 2 commits April 5, 2018 02:35

Changes for SIM AWSDBUX-19875

b376ba3

1. Add ONNX to Docs 2. Move Github to Community 3. ename Gluon Model Zoo to Model Zoo

Removing Gluon from the Navbar and correcting the link for ONNX

d6d6008

kpmurali requested a review from szha as a code owner April 7, 2018 01:14

Re-ordering the elements in the Navbar for SIM AWSDBUX-19875

af48505

marcoabreu reviewed Apr 7, 2018

View reviewed changes

In the navbar, changing the Github URL to to apache/incubator-mxnet

d59faf1

anirudh2290 reviewed Apr 9, 2018

View reviewed changes

anirudh2290 approved these changes Apr 9, 2018

View reviewed changes

Removing gluon and github from navbar.js

9ae73ed

mli reviewed Apr 17, 2018

View reviewed changes

Adding Gluon back to the Navbar

22b7aa9

anirudh2290 mentioned this pull request Apr 18, 2018

Additional v1.2.0 changes - install docs changes, website changes #10606

Merged

7 tasks

eric-haibin-lin merged commit 19c5212 into apache:master Apr 18, 2018

		@@ -1,5 +1,5 @@
		var searchBox = $("#search-input-wrap");
		var TITLE = ['/install/', '/gluon/' , '/api/', '/docs/', '/github/', '/community/', ];

Conversation

kpmurali commented Apr 7, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Changes

Uh oh!

marcoabreu Apr 7, 2018

Choose a reason for hiding this comment

Uh oh!

kpmurali commented Apr 9, 2018

Uh oh!

anirudh2290 Apr 9, 2018

Choose a reason for hiding this comment

Uh oh!

aaronmarkham Apr 9, 2018

Choose a reason for hiding this comment

Uh oh!

anirudh2290 commented Apr 10, 2018

Uh oh!

piiswrong commented Apr 10, 2018

Uh oh!

aaronmarkham commented Apr 10, 2018

Uh oh!

kpmurali commented Apr 13, 2018

Uh oh!

anirudh2290 commented Apr 17, 2018

Uh oh!

piiswrong commented Apr 17, 2018

Uh oh!

mli commented Apr 17, 2018

Uh oh!

mli Apr 17, 2018

Choose a reason for hiding this comment

Uh oh!

thomelane commented Apr 17, 2018

Uh oh!

aaronmarkham commented Apr 18, 2018

Uh oh!

srochel commented Apr 18, 2018

Uh oh!

kpmurali commented Apr 18, 2018

Uh oh!

aaronmarkham commented Apr 18, 2018

Uh oh!

kpmurali commented Apr 18, 2018

Uh oh!

anirudh2290 commented Apr 18, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

kpmurali commented Apr 7, 2018 •

edited

Loading