From dev-return-6719-archive-asf-public=cust-asf.ponee.io@mxnet.incubator.apache.org Sun Sep 22 09:04:24 2019 Return-Path: X-Original-To: archive-asf-public@cust-asf.ponee.io Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [207.244.88.153]) by mx-eu-01.ponee.io (Postfix) with SMTP id CDB5618065B for ; Sun, 22 Sep 2019 11:04:23 +0200 (CEST) Received: (qmail 70262 invoked by uid 500); 22 Sep 2019 09:04:22 -0000 Mailing-List: contact dev-help@mxnet.incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@mxnet.incubator.apache.org Delivered-To: mailing list dev@mxnet.incubator.apache.org Received: (qmail 70251 invoked by uid 99); 22 Sep 2019 09:04:22 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd3-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 22 Sep 2019 09:04:22 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd3-us-west.apache.org (ASF Mail Server at spamd3-us-west.apache.org) with ESMTP id 05D86181286 for ; Sun, 22 Sep 2019 09:04:22 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd3-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: 2.249 X-Spam-Level: ** X-Spam-Status: No, score=2.249 tagged_above=-999 required=6.31 tests=[HEADER_FROM_DIFFERENT_DOMAINS=0.25, HTML_MESSAGE=2, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001] autolearn=disabled Received: from mx1-ec2-va.apache.org ([10.40.0.8]) by localhost (spamd3-us-west.apache.org [10.40.0.10]) (amavisd-new, port 10024) with ESMTP id LfEhq9grSYKq for ; Sun, 22 Sep 2019 09:04:17 +0000 (UTC) Received-SPF: Pass (mailfrom) identity=mailfrom; client-ip=209.85.167.178; helo=mail-oi1-f178.google.com; envelope-from=lieven.govaerts@gmail.com; receiver= Received: from mail-oi1-f178.google.com (mail-oi1-f178.google.com [209.85.167.178]) by mx1-ec2-va.apache.org (ASF Mail Server at mx1-ec2-va.apache.org) with ESMTPS id 39501BC509 for ; Sun, 22 Sep 2019 09:04:17 +0000 (UTC) Received: by mail-oi1-f178.google.com with SMTP id x3so5244088oig.2 for ; Sun, 22 Sep 2019 02:04:17 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to; bh=69vrpb6U85Zlmk25dTfkoaLkDEFvBH/E7Pg2/YRhSkg=; b=L3MYqCC4XAeLi/2rrySW7C+pXa/1UrxppYTcvEkih2/VzR/l55G4F1415+Cyjch9Og tmQUHPFcBA8qAsTfGSEEe8FJWubr1IRjhaQ1d6JgDb6GIuhJuPuf4D96DtT/iKsP/YD7 MmYtNkGvy4qaxdb8mtYE7PP9kpDib2QKIvCBLIM2TaSkNDtUpDUT5LDUcbUSDL+nRMjG 6KKTFAjEqdM5GNDCQCQg/8Q//L/lICaqYRMjWP08I+Lmz1Y0DZnG2TUHMNX8P58TXk4/ t2KGJNGFMrFVbnBaNOuf5I2NEKP7tysK7L4jr2BUTI01bhHHX5m0ZnGZ8AOkfBVY6+5L AYag== X-Gm-Message-State: APjAAAX7/G2HeZL/cs2Kj5zxdOQrK8jx/lYTyACoS2h9eyjtYaksQy/g axKh+vYZuMHCwXxyUEgWJyNwBuSWOtFxXoKqZRXJQ5K9wUk= X-Google-Smtp-Source: APXvYqwRAMwrtNSaeVQ1zu6/P94WfIOj5BB/pNPpuRHTagB2TmeUgKbBfMw8ddSYr24qq1xkyYPZZua88v07BA75dGA= X-Received: by 2002:aca:cf51:: with SMTP id f78mr9862239oig.8.1569143056367; Sun, 22 Sep 2019 02:04:16 -0700 (PDT) MIME-Version: 1.0 References: In-Reply-To: From: Lieven Govaerts Date: Sun, 22 Sep 2019 11:03:59 +0200 Message-ID: Subject: Re: new website, docs code freeze To: dev@mxnet.incubator.apache.org Content-Type: multipart/alternative; boundary="0000000000007a04d5059320961e" --0000000000007a04d5059320961e Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Hi, On Sat, 21 Sep 2019 at 06:28, Thomas DELTEIL 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 nee= d > to be resolved and introduce opportunity for errors > - by releasing early, we can take advantage of the community contribution= s > 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 al= l > of them in parallel independently. > > There is PLENTY of room for improvement, it would be great if the communi= ty > 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 operato= rs > 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 organizati= on > 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 want= ed > 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 discoverabili= ty > 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 bette= r > 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 b= e > 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 with Nvidia 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 =C3=A0 09:53, Haibin Lin = a > =C3=A9crit : > > > 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 > > 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=C5=82aw Tr=C4=99dak > > > 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/mx= net.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 wrote: > > > > > Looks very neat. Thank you Aaron and many others for launching > this! > > > > > > > > > > On Fri, Sep 20, 2019 at 7:31 AM Carin Meier > > > > wrote: > > > > > > > > > > > Nice!!! Congrats everyone! > > > > > > > > > > > > On Fri, Sep 20, 2019 at 10:28 AM Aaron Markham < > > > > aaron.s.markham@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.markham@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 lik= e > to > > > > launch > > > > > > > > the new website today. > > > > > > > > > > > > > > > > On Wed, Sep 18, 2019 at 7:46 AM Aaron Markham < > > > > > > aaron.s.markham@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 unt= il > > 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 throug= h > 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 flow= s > > 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 wi= ll > > be > > > > > > > > > replaced with the new one. > > > > > > > > > > > > > > > > > > Post launch we'll need to update the DNS for beta.mxnet.i= o > > 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] > > > [image: > > https://www.facebook.com/chaibapat > > > ] > > > [image: > > > https://twitter.com/ChaiBapchya] > >[image: > > > https://www.linkedin.com//in/chaibapat25] > > > > > > > > > --0000000000007a04d5059320961e--