Update on the website: Highlights: - Broken links: a good amount of them have been fixed in this #16284 <https://github.com/apache/incubator-mxnet/pull/16284>, tutorials have been reorganized (not yet deployed because of CI). A new 404 with quick links has been added and deployed in #16287 <https://github.com/apache/incubator-mxnet/pull/16287> - Broken Search: Search has been fixed in #16284 <https://github.com/apache/incubator-mxnet/pull/16284> and merged but not deployed yet. - Google index issues: new website seems to be indexed now, in this google search: "MXNet NDArray" <https://www.google.com/search?q=mxnet+ndarray> new website is the top result. Redirects for old links to new ones have been added to the .htaccess, thanks Soji for the help! #16342 <https://github.com/apache/incubator-mxnet/pull/16342> is still waiting to be merged but a manual update to the website has been done in the meanwhile. - Automated analysis from google lighthouse scoring, compared to the old website: Performance saw a > ~100% improvement, SEO saw a ~25% improvement, and best practices improved by ~19%. Thanks Russell D. for running the analysis.
Remaining - *[high priority]* API docs are still missing some classes / packages / methods. ETA for fix is EOW, root cause has been identified, we are still deciding what's the best way forward for good discoverability as well as good coverage and maintainability. - Adding quick links to directly access Python API docs on homepage. All the best, Thomas Delteil Le mar. 24 sept. 2019 à 19:15, Thomas DELTEIL <thomas.delte...@gmail.com> a écrit : > @Philip Yes we're looking at link redirects for older links that might be > hosted externally (using htaccess is my preferred way to handle it for now > as you sugested) and we'll use a broken link checker to update the links > that are hosted internally. We'll update the 404 to add an explanation on > the website update. Google indexes will slowly update across the week so > the google search issues will be less of a problem. > > If you find any such links yourself, or missing tutorials, please consider > stepping up and helping fixing them. The more people get familiar with the > new website architecture, the least likely it is to fall in a state of > stalled updates like the previous one. > > For the sphinx issues in the python mini-website, missing API classes, if > anybody is familiar with it, I'd love for us to bring back the automatic > doc generation for each package so at least we have a list of all available > classes in each sub package rather than relying on manual insertion of each > class, which is brittle and not future proof. @Lin, Haibin > <haibi...@amazon.com> if you have experience with it, could we sync up > offline on how you suggest to do that based on your gluon-nlp experience? > > @Marco, I'm currently traveling for ICDAR in Sydney, and Aaron is on PTO > in Europe, I'll try make time today to help with the fixes since it is > impacting a lot of users. > > In the meanwhile, any help is appreciated, and more than the value of the > fixes, let me repeat that there is tremendous value in having more people > familiar with the website build pipelines. Aaron is the main owner for the > docs but he is already super busy with all his other responsibilities. I'm > available to help if anybody is stuck. I believe Aaron has updated the > READMEs on how to test the websites locally, if they're not clear, feel > free to contribute your own explanations or ask for help directly to me by > email or on the discuss forum. > > Good hunting! > > Thomas > > > > Le mer. 25 sept. 2019 à 10:10, Marco de Abreu <marco.g.ab...@gmail.com> a > écrit : > >> Good catch, Mu! Also good idea, Philip! >> >> Aaron and Thomas, are you going to work on this? >> >> -Marco >> >> On Wed, Sep 25, 2019 at 1:28 AM Mu Li <muli....@gmail.com> wrote: >> >> > The questions I found are: >> > >> > 1. Not ever page contains, especially the homepage >> > >> > >> http://mxnet.incubator.apache.org/api/python/docs/_static/google_analytics.js >> > 2. The correct tracking id is UA-96378503-1 instead of UA-96378503-11 in >> > >> > >> http://mxnet.incubator.apache.org/api/python/docs/_static/google_analytics.js >> > >> > On Tue, Sep 24, 2019 at 4:23 PM Mu Li <muli....@gmail.com> wrote: >> > >> > > I think the reason is that the google tracker is not included in the >> new >> > > website. >> > > >> > > On Tue, Sep 24, 2019 at 4:17 PM Marco de Abreu < >> marco.g.ab...@gmail.com> >> > > wrote: >> > > >> > >> Hello, >> > >> >> > >> I checked the Google Analytics statistics and the launch of the new >> > >> website reduced the traffic by over 80%: >> > >> >> > >> [image: image.png] >> > >> >> > >> (Please let me know if the image is not visible) >> > >> >> > >> How shall we handle this? >> > >> >> > >> Best regards, >> > >> Marco >> > >> >> > >> On Mon, Sep 23, 2019 at 7:30 AM Zhao, Patric <patric.z...@intel.com> >> > >> wrote: >> > >> >> > >>> For the install page [1], I suggest to add the selection of backend >> > >>> DeepNumpy [2] which will be more clean. >> > >>> >> > >>> [1] http://mxnet.incubator.apache.org/index.html >> > >>> [2] https://numpy.mxnet.io/#installation >> > >>> >> > >>> >> > >>> >> > >>> > -----Original Message----- >> > >>> > From: kellen sunderland <kellen.sunderl...@gmail.com> >> > >>> > Sent: Monday, September 23, 2019 12:47 PM >> > >>> > To: dev@mxnet.incubator.apache.org >> > >>> > Subject: Re: new website, docs code freeze >> > >>> > >> > >>> > New site looks good. I do notice that a few tutorials from the >> old >> > >>> site are >> > >>> > missing (for example the TensorRT tutorial). Any plans to bring >> them >> > >>> back? >> > >>> > >> > >>> > On Sun, Sep 22, 2019 at 10:04 AM Haibin Lin < >> > haibin.lin....@gmail.com> >> > >>> > wrote: >> > >>> > >> > >>> > > Another issue I found with the current website: the Sphinx >> object >> > >>> > > inventory >> > >>> > > <https://www.sphinx- >> > >>> > doc.org/en/master/usage/extensions/intersphinx.htm >> > >>> > > l> file https://mxnet.apache.org/objects.inv is missing. >> GluonNLP >> > >>> > > relies on this file to link document across projects. Shall we >> add >> > it >> > >>> > > back? >> > >>> > > >> > >>> > > Best, >> > >>> > > Haibin >> > >>> > > >> > >>> > > On Sun, Sep 22, 2019 at 2:04 AM Lieven Govaerts <l...@mobsol.be> >> > >>> wrote: >> > >>> > > >> > >>> > > > Hi, >> > >>> > > > >> > >>> > > > >> > >>> > > > On Sat, 21 Sep 2019 at 06:28, Thomas DELTEIL >> > >>> > > > <thomas.delte...@gmail.com> >> > >>> > > > wrote: >> > >>> > > > >> > >>> > > > > Thanks all for the feedback, >> > >>> > > > > >> > >>> > > > > We'll send an email next week with the list of missing >> > features, >> > >>> > > content >> > >>> > > > > and bugs that we plan to fix. >> > >>> > > > > We took the option of releasing early, with some features >> > >>> missing, >> > >>> > > rather >> > >>> > > > > than trying to be at feature parity with the old website >> before >> > >>> > > launching >> > >>> > > > > the website. >> > >>> > > > > The reason why we decided to do that is two-fold: >> > >>> > > > > - playing catch-up with docs in master introduce daily >> > conflicts >> > >>> > > > > that >> > >>> > > > need >> > >>> > > > > to be resolved and introduce opportunity for errors >> > >>> > > > > - by releasing early, we can take advantage of the community >> > >>> > > > contributions >> > >>> > > > > in modifying whatever the community feels like a better way >> of >> > >>> > > > > doing things. >> > >>> > > > > >> > >>> > > > > One of the goals of the new website was to disentangle the >> main >> > >>> > > website, >> > >>> > > > > now called "static_site" to the auto-generated docs. Now the >> > >>> > > > > overall >> > >>> > > site >> > >>> > > > > is made of a main static site, with easy to modify content >> and >> > >>> > > > > easy to understand architecture for anybody familiar with >> basic >> > >>> > > > > html, and a collection of mini-websites for each language >> > >>> bindings >> > >>> > > > > that can be >> > >>> > > built >> > >>> > > > in >> > >>> > > > > isolation and that are self-contained. Actually the new CI >> jobs >> > >>> > > > > builds >> > >>> > > > all >> > >>> > > > > of them in parallel independently. >> > >>> > > > > >> > >>> > > > > There is PLENTY of room for improvement, it would be great >> if >> > the >> > >>> > > > community >> > >>> > > > > can help contribute to bring the new website at the same >> level >> > of >> > >>> > > content >> > >>> > > > > richness as the old one, and then even further. >> > >>> > > > > >> > >>> > > > > Missing features: >> > >>> > > > > - As pointed by Haibin, the API docs do not have the full >> list >> > of >> > >>> > > > operators >> > >>> > > > > and classes. There is a mix of auto-generated docs based on >> > >>> > > > > packages, >> > >>> > > and >> > >>> > > > > some docs that are spelled out manually to improve the >> logical >> > >>> > > > organization >> > >>> > > > > of the package where there is a need. The drawback with >> > manually >> > >>> > > > > listed classes in a package is that it's very easy to miss >> > some. >> > >>> > > > > If someone >> > >>> > > > wanted >> > >>> > > > > to build a sanity check that would automatically detect >> which >> > >>> > > > > classes >> > >>> > > are >> > >>> > > > > not in the documentation, or if someone knew how to enable >> that >> > >>> > > > > with sphinx, that would be a great addition to the python >> docs >> > >>> > > > > - There is missing content in the python tutorials, and the >> > >>> > > > discoverability >> > >>> > > > > could be improved. Some old tutorials have not been migrated >> > >>> just yet. >> > >>> > > > > - The nightly tests on tutorials have been disabled for now >> > >>> > > > > - There is no "Download jupyter notebook" for tutorials just >> > yet. >> > >>> > > > > - Non-python tutorials might benefit from a blurb >> description >> > and >> > >>> > > > > a >> > >>> > > > better >> > >>> > > > > content organization. >> > >>> > > > > - Python tutorials could be better organized, have a picture >> > >>> > > accompanying >> > >>> > > > > their description >> > >>> > > > > - There is no site-wide search, this is not an easy problem >> to >> > >>> > > > > solve to >> > >>> > > > be >> > >>> > > > > fair given the static nature of the website, but maybe an >> > >>> external >> > >>> > > plugin >> > >>> > > > > might be able to give a half-way solution >> > >>> > > > > - There is no version selector for the docs >> > >>> > > > > - There is bug in search box of the python docs, but this is >> > just >> > >>> > > > > a >> > >>> > > small >> > >>> > > > > JS bug that can be fixed easily (on my list for next week) >> > >>> > > > > - Most old links have not had a redirect put in place. >> > >>> > > > > >> > >>> > > > > >> > >>> > > > I noticed on the Ubuntu home page in the Developer dropdown >> that >> > >>> the >> > >>> > > > link MXNet on Ubuntu >> > >>> > > > <https://mxnet.incubator.apache.org/install/index.html >> > >>> > > > >with >> > >>> > > > Nvidia >> > >>> > > > < >> > >>> > > > >> > >>> > > >> > >>> >> https://www.nvidia.com/en-us/data-center/gpu-accelerated-applications/ >> > >>> > > mxnet/ >> > >>> > > > > >> > >>> > > > doesn't work anymore, it points to: >> > >>> > > > https://mxnet.incubator.apache.org/install/index.html >> > >>> > > > >> > >>> > > > Also, on the MXNet 'getting started' page >> > >>> > > > https://mxnet.incubator.apache.org/get_started , the link >> > "Ubuntu >> > >>> > > > Installation Guide" at the bottom doesn't work either, it >> points >> > >>> to: >> > >>> > > > https://mxnet.incubator.apache.org/ubuntu_setup.html >> > >>> > > > >> > >>> > > > >> > >>> > > > I suggest you do a scan of the new website to find these >> dangling >> > >>> links. >> > >>> > > > >> > >>> > > > regards, >> > >>> > > > >> > >>> > > > Lieven >> > >>> > > > >> > >>> > > > >> > >>> > > > >> > >>> > > > > We'll formalize this in github issues next week, but they >> are >> > all >> > >>> > > fairly >> > >>> > > > > small and helping out on these would be a great way of >> > >>> > > > > familiarizing yourself with the new website build system and >> > >>> website >> > >>> > architecture. >> > >>> > > > > >> > >>> > > > > Thanks all for the feedback, please keep it coming! >> > >>> > > > > >> > >>> > > > > Thomas Delteil >> > >>> > > > > >> > >>> > > > > Le sam. 21 sept. 2019 à 09:53, Haibin Lin >> > >>> > > > > <haibin.lin....@gmail.com> a écrit : >> > >>> > > > > >> > >>> > > > > > It looks like my previous email did not go through. >> > Re-sending: >> > >>> > > > > > >> > >>> > > > > > Hi Aaron, >> > >>> > > > > > >> > >>> > > > > > The website looks cool. Thanks for pushing this to >> > production. >> > >>> A >> > >>> > > > > > few >> > >>> > > > > > questions: >> > >>> > > > > > >> > >>> > > > > > - I was looking for the API doc for mx.sym.dot, but I find >> > that >> > >>> > > > > > most operators under mx.sym.* are missing. Is this >> expected? >> > >>> > > > > > - I was also checking the search functionality, searching >> the >> > >>> > > > > > keyword "ndarray" only returns one result >> > >>> > > > > > "mxnet.ndarray.NDArray", which >> > >>> > > > doesn't >> > >>> > > > > > seem right. There animation keeps going (Searching. -> >> > >>> > > > > > Searching.. -> Searching ...) and gives me an impression >> that >> > >>> > > > > > the search is never completely done(?). >> > >>> > > > > > >> > >>> > > > > > Best, >> > >>> > > > > > Haibin >> > >>> > > > > > >> > >>> > > > > > >> > >>> > > > > > On Fri, Sep 20, 2019 at 4:50 PM Chaitanya Bapat < >> > >>> > > chai.ba...@gmail.com> >> > >>> > > > > > wrote: >> > >>> > > > > > >> > >>> > > > > > > Thanks Aaron and the team for launching new website! >> > >>> > > > > > > >> > >>> > > > > > > 1. There's no search button anywhere on the landing >> page. >> > >>> > > > > > > 2. I wasn't able to find FAQ (and without search button >> I >> > >>> dont >> > >>> > > > > > > have >> > >>> > > > > > option >> > >>> > > > > > > but to go manually on each menu). Only when I go to >> > >>> > > > > > > Docs&Tutorials >> > >>> > > -> >> > >>> > > > > FAQ >> > >>> > > > > > > -> Extend and Cotribute (that I got what I wanted). >> > >>> > > > > > > >> > >>> > > > > > > Suggestions >> > >>> > > > > > > Might want to make this searchable and pop FAQ on the >> main >> > >>> > > > > > > page (or somewhere prominent) >> > >>> > > > > > > >> > >>> > > > > > > Thanks, >> > >>> > > > > > > Chai >> > >>> > > > > > > >> > >>> > > > > > > >> > >>> > > > > > > On Fri, 20 Sep 2019 at 14:58, Przemysław Trędak < >> > >>> > > ptre...@apache.org> >> > >>> > > > > > > wrote: >> > >>> > > > > > > >> > >>> > > > > > > > There seems to be a problem with (at least Python, did >> > not >> > >>> > > > > > > > check >> > >>> > > > > > others) >> > >>> > > > > > > > APIs. For example this page: >> > >>> > > > > > > > >> > >>> > > > > > > > >> > >>> > > > > > > >> > >>> > > > > > >> > >>> > > > > >> > >>> > > > >> > >>> > > >> > >>> > >> > https://mxnet.incubator.apache.org/api/python/docs/api/symbol/_autogen >> > >>> > > /mxnet.symbol.Symbol.argmax.html >> > >>> > > > > > > > >> > >>> > > > > > > > says that it is a convenience method for argmax (with >> a >> > >>> > > > > > > > link), >> > >>> > > but >> > >>> > > > > > > > clicking that link just points to the same website >> (and >> > so >> > >>> > > > > > > > user >> > >>> > > has >> > >>> > > > > no >> > >>> > > > > > > way >> > >>> > > > > > > > of getting to the docs of the actual operator). >> > >>> > > > > > > > >> > >>> > > > > > > > When I tried to manually remove Symbol from the URL to >> > get >> > >>> > > > > > > > to mxnet.symbol.argmax.html, I got a "Not found" >> webpage >> > >>> > > > > > > > which I >> > >>> > > guess >> > >>> > > > > > also >> > >>> > > > > > > > should not happen (ignoring the fact that this should >> > >>> exist, >> > >>> > > going >> > >>> > > > to >> > >>> > > > > > > > random URL under the website should redirect to the >> main >> > >>> > > > > > > > page I >> > >>> > > > > think). >> > >>> > > > > > > > >> > >>> > > > > > > > Przemek >> > >>> > > > > > > > >> > >>> > > > > > > > On 2019/09/20 16:41:28, Lin Yuan <apefor...@gmail.com >> > >> > >>> wrote: >> > >>> > > > > > > > > Looks very neat. Thank you Aaron and many others for >> > >>> > > > > > > > > launching >> > >>> > > > > this! >> > >>> > > > > > > > > >> > >>> > > > > > > > > On Fri, Sep 20, 2019 at 7:31 AM Carin Meier < >> > >>> > > > carinme...@gmail.com> >> > >>> > > > > > > > wrote: >> > >>> > > > > > > > > >> > >>> > > > > > > > > > Nice!!! Congrats everyone! >> > >>> > > > > > > > > > >> > >>> > > > > > > > > > On Fri, Sep 20, 2019 at 10:28 AM Aaron Markham < >> > >>> > > > > > > > aaron.s.mark...@gmail.com> >> > >>> > > > > > > > > > wrote: >> > >>> > > > > > > > > > >> > >>> > > > > > > > > > > Alrighty! The new site is launched. You might >> need >> > to >> > >>> > > > > > > > > > > clear >> > >>> > > > > your >> > >>> > > > > > > > cache. >> > >>> > > > > > > > > > > >> > >>> > > > > > > > > > > Cheers, >> > >>> > > > > > > > > > > Aaron >> > >>> > > > > > > > > > > >> > >>> > > > > > > > > > > On Thu, Sep 19, 2019 at 3:33 PM Aaron Markham < >> > >>> > > > > > > > aaron.s.mark...@gmail.com >> > >>> > > > > > > > > > > >> > >>> > > > > > > > > > > wrote: >> > >>> > > > > > > > > > > > >> > >>> > > > > > > > > > > > Thanks everyone. The PRs passed CI, but please >> > >>> > > > > > > > > > > > continue >> > >>> > > > > holding >> > >>> > > > > > > > off on >> > >>> > > > > > > > > > > > docs and CI edits. Unless there are any >> > objections, >> > >>> > > > > > > > > > > > I'd >> > >>> > > > like >> > >>> > > > > to >> > >>> > > > > > > > launch >> > >>> > > > > > > > > > > > the new website today. >> > >>> > > > > > > > > > > > >> > >>> > > > > > > > > > > > On Wed, Sep 18, 2019 at 7:46 AM Aaron Markham >> < >> > >>> > > > > > > > > > aaron.s.mark...@gmail.com> >> > >>> > > > > > > > > > > wrote: >> > >>> > > > > > > > > > > > > >> > >>> > > > > > > > > > > > > Hi everyone, >> > >>> > > > > > > > > > > > > The last two PRs [1][2] for the new website >> and >> > >>> > > > > > > > > > > > > docs >> > >>> > > have >> > >>> > > > > > > passed >> > >>> > > > > > > > CI >> > >>> > > > > > > > > > > > > (finally). Please do not make changes to >> /docs >> > or >> > >>> > > > > > > > > > > > > /ci >> > >>> > > > until >> > >>> > > > > > we >> > >>> > > > > > > > get >> > >>> > > > > > > > > > > > > these approved and merged. Every time >> there's a >> > >>> > > > > > > > > > > > > merge >> > >>> > > > > > conflict >> > >>> > > > > > > > it has >> > >>> > > > > > > > > > > > > set us back a day or two while shepherding >> the >> > >>> PRs >> > >>> > > > through >> > >>> > > > > CI >> > >>> > > > > > > > again. >> > >>> > > > > > > > > > > > > Unless there are catastrophic issues >> discovered >> > >>> in >> > >>> > > > > > > > > > > > > a >> > >>> > > > > review, >> > >>> > > > > > I >> > >>> > > > > > > > > > > > > recommend that we hold any patches or >> updates >> > to >> > >>> > > > > > > > > > > > > the >> > >>> > > PRs >> > >>> > > > to >> > >>> > > > > > > > follow-up >> > >>> > > > > > > > > > > > > PRs. >> > >>> > > > > > > > > > > > > >> > >>> > > > > > > > > > > > > There are four steps to launch: >> > >>> > > > > > > > > > > > > 1. Once the PRs are approved, the plan is to >> > >>> merge >> > >>> > > 15885 >> > >>> > > > to >> > >>> > > > > > > > delete >> > >>> > > > > > > > > > the >> > >>> > > > > > > > > > > > > old content first. >> > >>> > > > > > > > > > > > > 2. Then immediately merge 15883 to add in >> the >> > new >> > >>> > > > > > > > > > > > > CI >> > >>> > > > flows >> > >>> > > > > > and >> > >>> > > > > > > > > > updates >> > >>> > > > > > > > > > > > > to the content Thomas and I have already had >> > >>> > > > > > > > > > > > > merged in >> > >>> > > > > 15884 >> > >>> > > > > > > [3]. >> > >>> > > > > > > > > > > > > 3. I will change the website validation >> Jenkins >> > >>> > > pipeline >> > >>> > > > to >> > >>> > > > > > > > point to >> > >>> > > > > > > > > > > > > the new pipeline. >> > >>> > > > > > > > > > > > > 4. I will change the website publishing >> Jenkins >> > >>> > > pipeline >> > >>> > > > to >> > >>> > > > > > > > point to >> > >>> > > > > > > > > > > > > its new pipeline as well. Once triggered, >> the >> > old >> > >>> > > > > > > > > > > > > site >> > >>> > > > will >> > >>> > > > > > be >> > >>> > > > > > > > > > > > > replaced with the new one. >> > >>> > > > > > > > > > > > > >> > >>> > > > > > > > > > > > > Post launch we'll need to update the DNS for >> > >>> > > > beta.mxnet.io >> > >>> > > > > > to >> > >>> > > > > > > > point >> > >>> > > > > > > > > > to >> > >>> > > > > > > > > > > > > production, and there will likely be some >> > >>> > > > > redirect/.htaccess >> > >>> > > > > > > > updates >> > >>> > > > > > > > > > > > > needed next week to assist with any deep >> > linking >> > >>> > > > > > > > > > > > > and >> > >>> > > 404 >> > >>> > > > > > issues >> > >>> > > > > > > > that >> > >>> > > > > > > > > > > > > pop up. >> > >>> > > > > > > > > > > > > >> > >>> > > > > > > > > > > > > Cheers, >> > >>> > > > > > > > > > > > > Aaron >> > >>> > > > > > > > > > > > > >> > >>> > > > > > > > > > > > > [1] >> > >>> > > https://github.com/apache/incubator-mxnet/pull/15885 >> > >>> > > > > > > > > > > > > [2] >> > >>> > > https://github.com/apache/incubator-mxnet/pull/15883 >> > >>> > > > > > > > > > > > > [3] >> > >>> > > https://github.com/apache/incubator-mxnet/pull/15884 >> > >>> > > > > > > > > > > >> > >>> > > > > > > > > > >> > >>> > > > > > > > > >> > >>> > > > > > > > >> > >>> > > > > > > >> > >>> > > > > > > >> > >>> > > > > > > -- >> > >>> > > > > > > *Chaitanya Prakash Bapat* >> > >>> > > > > > > *+1 (973) 953-6299* >> > >>> > > > > > > >> > >>> > > > > > > [image: https://www.linkedin.com//in/chaibapat25] >> > >>> > > > > > > <https://github.com/ChaiBapchya>[image: >> > >>> > > > > > https://www.facebook.com/chaibapat >> > >>> > > > > > > ] >> > >>> > > > > > > <https://www.facebook.com/chaibapchya>[image: >> > >>> > > > > > > https://twitter.com/ChaiBapchya] >> > >>> > > > > > ><https://twitter.com/ChaiBapchya >> > >>> > > > > > >[image: >> > >>> > > > > > > https://www.linkedin.com//in/chaibapat25] >> > >>> > > > > > > <https://www.linkedin.com//in/chaibapchya/> >> > >>> > > > > > > >> > >>> > > > > > >> > >>> > > > > >> > >>> > > > >> > >>> > > >> > >>> >> > >> >> > >> >
