Re: new website, docs code freeze
Update on the docs: @Tao see comments on your PR for what needs to be updated in the docs for the release. Soji (thanks a lot) just contributed a big improvement to the docs. The doc coverage is now at ~100%, which an improvement compared to the previous website. This should be taking care of all or most of the issues around missing operators / packages / functions. https://mxnet.apache.org/api/python/docs/api/index.html Next improvements on the docs coming up: - more broken links to be fixed, more missing tutorials to be added back - usability fix: adding a direct link to the Python docs on the home page (requested by Matthias Seeger, Haibin Lin) - PR preview pipeline to be sorted out (Aaron is contributing a half-way solution that would allow specific PRs to be deployed to the beta staging env) All the best, Thomas Le mar. 8 oct. 2019 à 19:40, Tao Lv a écrit : > I just sent out the announcement of 1.5.1 release for review. But still not > sure how to change http://mxnet.incubator.apache.org/get_started and > http://mxnet.incubator.apache.org/get_started/download to accommodate. > > Can anyone help on that? > > thanks, > -tao > > On Wed, Oct 9, 2019 at 10:24 AM Zhao, Patric > wrote: > > > Thanks, Thomas, it's good to have a site-wide search bar > > > > > > > > FYI, the similar thing in https://pytorch.org/ > > > > > > > > --Patric > > > > > > > > > -Original Message- > > > > > From: Thomas DELTEIL > > > > > Sent: Wednesday, October 9, 2019 1:41 AM > > > > > To: dev@mxnet.incubator.apache.org > > > > > Subject: Re: new website, docs code freeze > > > > > > > > > > Hi Patric, > > > > > > > > > > The search bar is available in the python docs: > > > > > https://mxnet.apache.org/api/python/docs/api/ (on the top right). > Since > > the > > > > > homepage is not built by sphinx anymore there are no more search bar > > there. > > > > > We are considering using an external plugin to maintain a site-wide > > index and > > > > > provide better search experience than the sphinx one. > > > > > btw you were asking about the mkldnn tutorials, they are now here: > > > > > https://mxnet.apache.org/api/python/docs/tutorials/performance/backend > > > > > /mkldnn/index.html > > > > > > > > > > All the best, > > > > > > > > > > Thomas Delteil > > > > > > > > > > Le lun. 7 oct. 2019 à 19:58, Zhao, Patric a > > écrit : > > > > > > > > > > > I find there is no "search bar" in the website today. > > > > > > > > > > > > Could anyone check it? > > > > > > > > > > > > Thanks, > > > > > > > > > > > > --Patric > > > > > > > > > > > > > -Original Message- > > > > > > > From: Thomas DELTEIL > > > > > > > Sent: Saturday, October 5, 2019 3:41 AM > > > > > > > To: dev@mxnet.incubator.apache.org > > > > > > > Subject: Re: new website, docs code freeze > > > > > > > > > > > > > > Hi Haibin, > > > > > > > > > > > > > > We are currently working with Soji on overhauling the way the > python > > > > > > > docs are organized to get better and more consistent docs with full > > > > > > > coverage, > > > > > > the > > > > > > > current system is a brittle and hard to browse. We hope to finish > > > > > > > our dev work by tonight, ETA for early next week. > > > > > > > There is no ETA on bringing back the old docs, though that's the > > > > > > > next > > > > > > highest > > > > > > > priority feature on the list after improving the coverage of the > > > > > > > python > > > > > > API. > > > > > > > > > > > > > > All the best, > > > > > > > > > > > > > > Thomas Delteil > > > > > > > > > > > > > > On Fri, Oct 4, 2019, 12:34 Haibin Lin > > wrote: > > > > > > > > > > > > > > > Yes, that is the correct one. > > > > > > > > > > > > > > > > On a separate note, are we removing
Re: new website, docs code freeze
I just sent out the announcement of 1.5.1 release for review. But still not sure how to change http://mxnet.incubator.apache.org/get_started and http://mxnet.incubator.apache.org/get_started/download to accommodate. Can anyone help on that? thanks, -tao On Wed, Oct 9, 2019 at 10:24 AM Zhao, Patric wrote: > Thanks, Thomas, it's good to have a site-wide search bar > > > > FYI, the similar thing in https://pytorch.org/ > > > > --Patric > > > > > -Original Message- > > > From: Thomas DELTEIL > > > Sent: Wednesday, October 9, 2019 1:41 AM > > > To: dev@mxnet.incubator.apache.org > > > Subject: Re: new website, docs code freeze > > > > > > Hi Patric, > > > > > > The search bar is available in the python docs: > > > https://mxnet.apache.org/api/python/docs/api/ (on the top right). Since > the > > > homepage is not built by sphinx anymore there are no more search bar > there. > > > We are considering using an external plugin to maintain a site-wide > index and > > > provide better search experience than the sphinx one. > > > btw you were asking about the mkldnn tutorials, they are now here: > > > https://mxnet.apache.org/api/python/docs/tutorials/performance/backend > > > /mkldnn/index.html > > > > > > All the best, > > > > > > Thomas Delteil > > > > > > Le lun. 7 oct. 2019 à 19:58, Zhao, Patric a > écrit : > > > > > > > I find there is no "search bar" in the website today. > > > > > > > > Could anyone check it? > > > > > > > > Thanks, > > > > > > > > --Patric > > > > > > > > > -Original Message- > > > > > From: Thomas DELTEIL > > > > > Sent: Saturday, October 5, 2019 3:41 AM > > > > > To: dev@mxnet.incubator.apache.org > > > > > Subject: Re: new website, docs code freeze > > > > > > > > > > Hi Haibin, > > > > > > > > > > We are currently working with Soji on overhauling the way the python > > > > > docs are organized to get better and more consistent docs with full > > > > > coverage, > > > > the > > > > > current system is a brittle and hard to browse. We hope to finish > > > > > our dev work by tonight, ETA for early next week. > > > > > There is no ETA on bringing back the old docs, though that's the > > > > > next > > > > highest > > > > > priority feature on the list after improving the coverage of the > > > > > python > > > > API. > > > > > > > > > > All the best, > > > > > > > > > > Thomas Delteil > > > > > > > > > > On Fri, Oct 4, 2019, 12:34 Haibin Lin > wrote: > > > > > > > > > > > Yes, that is the correct one. > > > > > > > > > > > > On a separate note, are we removing documentation versioning from > > > > > > the website? How do we switch between the master/nightly version > > > > > > and the stable version for the python API doc? Maybe there's a > > > > > > switch somewhere but I cannot find it. > > > > > > > > > > > > Also, I find that the API doc for many methods are missing, for > > > > > > example, the Dataset.transform function has detailed documentation > > > > > > on input and output types, but the doc only shows the one-line > > > > > > description of the method > > > > > > > > > > > > > > > > > > > > https://mxnet.apache.org/api/python/docs/api/gluon/_autogen/mxnet.gl > > > > > u > > > > > o > > > > > > n.data.Dataset.html?highlight=dataset# > > > > > > . > > > > > > Same for other methods such as filter, shard, etc. > > > > > > > > > > > > Thanks. > > > > > > > > > > > > Best, > > > > > > Haibin > > > > > > > > > > > > > > > > > > On Thu, Oct 3, 2019 at 7:59 AM Aaron Markham > > > > > > > > > > > > wrote: > > > > > > > > > > > > > Hi Haibin, you mean this one? > > > > > > > > > > > > > > > >
RE: new website, docs code freeze
Thanks, Thomas, it's good to have a site-wide search bar FYI, the similar thing in https://pytorch.org/ --Patric > -Original Message- > From: Thomas DELTEIL > Sent: Wednesday, October 9, 2019 1:41 AM > To: dev@mxnet.incubator.apache.org > Subject: Re: new website, docs code freeze > > Hi Patric, > > The search bar is available in the python docs: > https://mxnet.apache.org/api/python/docs/api/ (on the top right). Since the > homepage is not built by sphinx anymore there are no more search bar there. > We are considering using an external plugin to maintain a site-wide index and > provide better search experience than the sphinx one. > btw you were asking about the mkldnn tutorials, they are now here: > https://mxnet.apache.org/api/python/docs/tutorials/performance/backend > /mkldnn/index.html > > All the best, > > Thomas Delteil > > Le lun. 7 oct. 2019 à 19:58, Zhao, Patric a écrit : > > > I find there is no "search bar" in the website today. > > > > Could anyone check it? > > > > Thanks, > > > > --Patric > > > > > -Original Message- > > > From: Thomas DELTEIL > > > Sent: Saturday, October 5, 2019 3:41 AM > > > To: dev@mxnet.incubator.apache.org > > > Subject: Re: new website, docs code freeze > > > > > > Hi Haibin, > > > > > > We are currently working with Soji on overhauling the way the python > > > docs are organized to get better and more consistent docs with full > > > coverage, > > the > > > current system is a brittle and hard to browse. We hope to finish > > > our dev work by tonight, ETA for early next week. > > > There is no ETA on bringing back the old docs, though that's the > > > next > > highest > > > priority feature on the list after improving the coverage of the > > > python > > API. > > > > > > All the best, > > > > > > Thomas Delteil > > > > > > On Fri, Oct 4, 2019, 12:34 Haibin Lin wrote: > > > > > > > Yes, that is the correct one. > > > > > > > > On a separate note, are we removing documentation versioning from > > > > the website? How do we switch between the master/nightly version > > > > and the stable version for the python API doc? Maybe there's a > > > > switch somewhere but I cannot find it. > > > > > > > > Also, I find that the API doc for many methods are missing, for > > > > example, the Dataset.transform function has detailed documentation > > > > on input and output types, but the doc only shows the one-line > > > > description of the method > > > > > > > > > > > > https://mxnet.apache.org/api/python/docs/api/gluon/_autogen/mxnet.gl > > > u > > > o > > > > n.data.Dataset.html?highlight=dataset# > > > > . > > > > Same for other methods such as filter, shard, etc. > > > > > > > > Thanks. > > > > > > > > Best, > > > > Haibin > > > > > > > > > > > > On Thu, Oct 3, 2019 at 7:59 AM Aaron Markham > > > > > > > > wrote: > > > > > > > > > Hi Haibin, you mean this one? > > > > > > > > > > > > > > https://github.com/apache/incubator- > > > mxnet/blob/master/docs/static_site > > > > /src/pages/api/faq/distributed_training.md > > > > > If so, it looks like a link update is needed. > > > > > > > > > > On Wed, Oct 2, 2019 at 9:42 PM Haibin Lin > > > > > > > > > > wrote: > > > > > > > > > > > > I find that the 'distributed training with KVStore' tutorial > > > > > > is > > gone. > > > > Are > > > > > > we adding it back? > > > > > > > > > > > > > > > > > > > https://mxnet.apache.org/api/python/docs/tutorials/performance/index > > > .h > > > > tml?highlight=distributed#distributed-training > > > > > > > > > > > > > > > > > > On Tue, Oct 1, 2019 at 4:54 AM Marco de Abreu > > > > > > > > > > > > > > > > wrote: > > > > > > > > > > > > > Thanks for the update,
Re: new website, docs code freeze
Hi Patric, The search bar is available in the python docs: https://mxnet.apache.org/api/python/docs/api/ (on the top right). Since the homepage is not built by sphinx anymore there are no more search bar there. We are considering using an external plugin to maintain a site-wide index and provide better search experience than the sphinx one. btw you were asking about the mkldnn tutorials, they are now here: https://mxnet.apache.org/api/python/docs/tutorials/performance/backend/mkldnn/index.html All the best, Thomas Delteil Le lun. 7 oct. 2019 à 19:58, Zhao, Patric a écrit : > I find there is no "search bar" in the website today. > > Could anyone check it? > > Thanks, > > --Patric > > > -Original Message- > > From: Thomas DELTEIL > > Sent: Saturday, October 5, 2019 3:41 AM > > To: dev@mxnet.incubator.apache.org > > Subject: Re: new website, docs code freeze > > > > Hi Haibin, > > > > We are currently working with Soji on overhauling the way the python docs > > are organized to get better and more consistent docs with full coverage, > the > > current system is a brittle and hard to browse. We hope to finish our dev > > work by tonight, ETA for early next week. > > There is no ETA on bringing back the old docs, though that's the next > highest > > priority feature on the list after improving the coverage of the python > API. > > > > All the best, > > > > Thomas Delteil > > > > On Fri, Oct 4, 2019, 12:34 Haibin Lin wrote: > > > > > Yes, that is the correct one. > > > > > > On a separate note, are we removing documentation versioning from the > > > website? How do we switch between the master/nightly version and the > > > stable version for the python API doc? Maybe there's a switch > > > somewhere but I cannot find it. > > > > > > Also, I find that the API doc for many methods are missing, for > > > example, the Dataset.transform function has detailed documentation on > > > input and output types, but the doc only shows the one-line > > > description of the method > > > > > > > > https://mxnet.apache.org/api/python/docs/api/gluon/_autogen/mxnet.glu > > o > > > n.data.Dataset.html?highlight=dataset# > > > . > > > Same for other methods such as filter, shard, etc. > > > > > > Thanks. > > > > > > Best, > > > Haibin > > > > > > > > > On Thu, Oct 3, 2019 at 7:59 AM Aaron Markham > > > > > > wrote: > > > > > > > Hi Haibin, you mean this one? > > > > > > > > > > > https://github.com/apache/incubator- > > mxnet/blob/master/docs/static_site > > > /src/pages/api/faq/distributed_training.md > > > > If so, it looks like a link update is needed. > > > > > > > > On Wed, Oct 2, 2019 at 9:42 PM Haibin Lin > > > > wrote: > > > > > > > > > > I find that the 'distributed training with KVStore' tutorial is > gone. > > > Are > > > > > we adding it back? > > > > > > > > > > > > > > https://mxnet.apache.org/api/python/docs/tutorials/performance/index.h > > > tml?highlight=distributed#distributed-training > > > > > > > > > > > > > > > On Tue, Oct 1, 2019 at 4:54 AM Marco de Abreu > > > > > > > > > > > > > wrote: > > > > > > > > > > > Thanks for the update, great job! > > > > > > > > > > > > Are the lighthouse results accessible somewhere? I'd be curious. > > > > > > > > > > > > -Marco > > > > > > > > > > > > Thomas DELTEIL schrieb am Di., 1. > Okt. > > > > 2019, > > > > > > 13:49: > > > > > > > > > > > > > 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 > > > > > > >
RE: new website, docs code freeze
I find there is no "search bar" in the website today. Could anyone check it? Thanks, --Patric > -Original Message- > From: Thomas DELTEIL > Sent: Saturday, October 5, 2019 3:41 AM > To: dev@mxnet.incubator.apache.org > Subject: Re: new website, docs code freeze > > Hi Haibin, > > We are currently working with Soji on overhauling the way the python docs > are organized to get better and more consistent docs with full coverage, the > current system is a brittle and hard to browse. We hope to finish our dev > work by tonight, ETA for early next week. > There is no ETA on bringing back the old docs, though that's the next highest > priority feature on the list after improving the coverage of the python API. > > All the best, > > Thomas Delteil > > On Fri, Oct 4, 2019, 12:34 Haibin Lin wrote: > > > Yes, that is the correct one. > > > > On a separate note, are we removing documentation versioning from the > > website? How do we switch between the master/nightly version and the > > stable version for the python API doc? Maybe there's a switch > > somewhere but I cannot find it. > > > > Also, I find that the API doc for many methods are missing, for > > example, the Dataset.transform function has detailed documentation on > > input and output types, but the doc only shows the one-line > > description of the method > > > > > https://mxnet.apache.org/api/python/docs/api/gluon/_autogen/mxnet.glu > o > > n.data.Dataset.html?highlight=dataset# > > . > > Same for other methods such as filter, shard, etc. > > > > Thanks. > > > > Best, > > Haibin > > > > > > On Thu, Oct 3, 2019 at 7:59 AM Aaron Markham > > > > wrote: > > > > > Hi Haibin, you mean this one? > > > > > > > > https://github.com/apache/incubator- > mxnet/blob/master/docs/static_site > > /src/pages/api/faq/distributed_training.md > > > If so, it looks like a link update is needed. > > > > > > On Wed, Oct 2, 2019 at 9:42 PM Haibin Lin > > > wrote: > > > > > > > > I find that the 'distributed training with KVStore' tutorial is gone. > > Are > > > > we adding it back? > > > > > > > > > > https://mxnet.apache.org/api/python/docs/tutorials/performance/index.h > > tml?highlight=distributed#distributed-training > > > > > > > > > > > > On Tue, Oct 1, 2019 at 4:54 AM Marco de Abreu > > > > > > > > > > wrote: > > > > > > > > > Thanks for the update, great job! > > > > > > > > > > Are the lighthouse results accessible somewhere? I'd be curious. > > > > > > > > > > -Marco > > > > > > > > > > Thomas DELTEIL schrieb am Di., 1. Okt. > > > 2019, > > > > > 13:49: > > > > > > > > > > > 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 > >
Re: new website, docs code freeze
@Marco Lighthouse Reports https://cwiki.apache.org/confluence/display/MXNET/New+Website+Lighthouse+Reports, forgot about that @Haibin and others: WIP PR to re-reorganize and add full coverage of the python docs API: https://github.com/apache/incubator-mxnet/pull/16377 Le ven. 4 oct. 2019 à 12:41, Thomas DELTEIL a écrit : > Hi Haibin, > > We are currently working with Soji on overhauling the way the python docs > are organized to get better and more consistent docs with full coverage, > the current system is a brittle and hard to browse. We hope to finish our > dev work by tonight, ETA for early next week. > There is no ETA on bringing back the old docs, though that's the next > highest priority feature on the list after improving the coverage of the > python API. > > All the best, > > Thomas Delteil > > On Fri, Oct 4, 2019, 12:34 Haibin Lin wrote: > >> Yes, that is the correct one. >> >> On a separate note, are we removing documentation versioning from the >> website? How do we switch between the master/nightly version and the >> stable >> version for the python API doc? Maybe there's a switch somewhere but I >> cannot find it. >> >> Also, I find that the API doc for many methods are missing, for example, >> the Dataset.transform function has detailed documentation on input and >> output types, but the doc only shows the one-line description of the >> method >> >> https://mxnet.apache.org/api/python/docs/api/gluon/_autogen/mxnet.gluon.data.Dataset.html?highlight=dataset# >> . >> Same for other methods such as filter, shard, etc. >> >> Thanks. >> >> Best, >> Haibin >> >> >> On Thu, Oct 3, 2019 at 7:59 AM Aaron Markham >> wrote: >> >> > Hi Haibin, you mean this one? >> > >> > >> https://github.com/apache/incubator-mxnet/blob/master/docs/static_site/src/pages/api/faq/distributed_training.md >> > If so, it looks like a link update is needed. >> > >> > On Wed, Oct 2, 2019 at 9:42 PM Haibin Lin >> > wrote: >> > > >> > > I find that the 'distributed training with KVStore' tutorial is gone. >> Are >> > > we adding it back? >> > > >> > >> https://mxnet.apache.org/api/python/docs/tutorials/performance/index.html?highlight=distributed#distributed-training >> > > >> > > >> > > On Tue, Oct 1, 2019 at 4:54 AM Marco de Abreu < >> marco.g.ab...@gmail.com> >> > > wrote: >> > > >> > > > Thanks for the update, great job! >> > > > >> > > > Are the lighthouse results accessible somewhere? I'd be curious. >> > > > >> > > > -Marco >> > > > >> > > > Thomas DELTEIL schrieb am Di., 1. Okt. >> > 2019, >> > > > 13:49: >> > > > >> > > > > 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: P
Re: new website, docs code freeze
Hi Haibin, We are currently working with Soji on overhauling the way the python docs are organized to get better and more consistent docs with full coverage, the current system is a brittle and hard to browse. We hope to finish our dev work by tonight, ETA for early next week. There is no ETA on bringing back the old docs, though that's the next highest priority feature on the list after improving the coverage of the python API. All the best, Thomas Delteil On Fri, Oct 4, 2019, 12:34 Haibin Lin wrote: > Yes, that is the correct one. > > On a separate note, are we removing documentation versioning from the > website? How do we switch between the master/nightly version and the stable > version for the python API doc? Maybe there's a switch somewhere but I > cannot find it. > > Also, I find that the API doc for many methods are missing, for example, > the Dataset.transform function has detailed documentation on input and > output types, but the doc only shows the one-line description of the method > > https://mxnet.apache.org/api/python/docs/api/gluon/_autogen/mxnet.gluon.data.Dataset.html?highlight=dataset# > . > Same for other methods such as filter, shard, etc. > > Thanks. > > Best, > Haibin > > > On Thu, Oct 3, 2019 at 7:59 AM Aaron Markham > wrote: > > > Hi Haibin, you mean this one? > > > > > https://github.com/apache/incubator-mxnet/blob/master/docs/static_site/src/pages/api/faq/distributed_training.md > > If so, it looks like a link update is needed. > > > > On Wed, Oct 2, 2019 at 9:42 PM Haibin Lin > > wrote: > > > > > > I find that the 'distributed training with KVStore' tutorial is gone. > Are > > > we adding it back? > > > > > > https://mxnet.apache.org/api/python/docs/tutorials/performance/index.html?highlight=distributed#distributed-training > > > > > > > > > On Tue, Oct 1, 2019 at 4:54 AM Marco de Abreu > > > > wrote: > > > > > > > Thanks for the update, great job! > > > > > > > > Are the lighthouse results accessible somewhere? I'd be curious. > > > > > > > > -Marco > > > > > > > > Thomas DELTEIL schrieb am Di., 1. Okt. > > 2019, > > > > 13:49: > > > > > > > > > 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. > > > > > > > > > &g
Re: new website, docs code freeze
I find that the 'distributed training with KVStore' tutorial is gone. Are we adding it back? https://mxnet.apache.org/api/python/docs/tutorials/performance/index.html?highlight=distributed#distributed-training On Tue, Oct 1, 2019 at 4:54 AM Marco de Abreu wrote: > Thanks for the update, great job! > > Are the lighthouse results accessible somewhere? I'd be curious. > > -Marco > > Thomas DELTEIL schrieb am Di., 1. Okt. 2019, > 13:49: > > > 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 > > > 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 > > > 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 dis
Re: new website, docs code freeze
Thanks for the update, great job! Are the lighthouse results accessible somewhere? I'd be curious. -Marco Thomas DELTEIL schrieb am Di., 1. Okt. 2019, 13:49: > 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 > 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 > > 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 > 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 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
Re: new website, docs code freeze
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 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 > 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 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 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 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 >>
Re: new website, docs code freeze
Good observations... @Zhi - added the feature request: https://github.com/apache/incubator-mxnet/issues/16323 I really think the site needs a commercial-grade search indexing service to deal with all of the microsites and the duplicate content that happens to be API specific. Too often, I saw Sphinx search results that just listed the method a hundred times without any context so you'd have to mouseover the link to see if was going to take you to the right place. @Anirudh - added the issue: https://github.com/apache/incubator-mxnet/issues/16322 On Fri, Sep 27, 2019 at 3:49 PM Joshua Z. Zhang wrote: > > I’ve heard existing users are in general happy with the new site’s modern > appearance. > > The biggest issue is that the search bar is now hidden way too deep in the > python api page, where only experienced users can locate. We might need a > search button on the navbar. > > Best, > Zhi > > > On Sep 26, 2019, at 9:24 AM, Anirudh Acharya wrote: > > > > Hi, > > > > In the operator tutorial( > > http://mxnet.incubator.apache.org/api/faq/add_op_in_backend), there are > > sections which do not render properly, for example - forward function, > > backward function and shape inference. > > > > > > Thanks > > Anirudh > > > > > > > > > > On Wed, Sep 25, 2019 at 7:53 AM Aaron Markham > > wrote: > > > >> I'm seeing GA code is -1 not -11 in the analytics admin console. 11 > >> was for beta.mxnet.io. > >> Either way, the Jekyll prod config file was missing the GA code, so I > >> added it with this PR: > >> https://github.com/apache/incubator-mxnet/pull/16271 > >> > >> Reindexing of the site is being tracked here: > >> https://issues.apache.org/jira/browse/INFRA-19144 > >> > >> .htaccess testing was hampered by it not working on staging. This was > >> tracked here, and it looks like infra just patched staging so we can > >> resume redirect testing: > >> https://issues.apache.org/jira/browse/INFRA-19075 > >> I have a CI pipeline for beta testing. If anyone wants to contribute > >> to working on the redirects, you can use this pipeline to publish to > >> the beta staging site. > >> http://jenkins.mxnet-ci.amazon-ml.com/job/restricted-website-publish-beta/ > >> I've distilled this information in this issue: > >> https://github.com/apache/incubator-mxnet/issues/16273 > >> I'd much rather have another contributor work on this since it will > >> teach testing changes on the website, testing CI deployments to > >> staging using your fork, previewing on staging, and finally deploying > >> it to prod. I'm happy to help & guide along the way. > >> > >> (echoing Thomas) Please be sure to raise new issues in the repo, so we > >> don't lose them in this thread. Also, more people can work on them. It > >> would great if others can jump in and get familiar with the new site > >> and start contributing patches. > >> > >> Cheers, > >> Aaron > >> > >> On Wed, Sep 25, 2019 at 3:15 AM Thomas DELTEIL > >> wrote: > >>> > >>> @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 > >>> if you have experience with it, could we sync up > >>> offline on how you suggest to do that based on your gluon-nlp experience? >
Re: new website, docs code freeze
I’ve heard existing users are in general happy with the new site’s modern appearance. The biggest issue is that the search bar is now hidden way too deep in the python api page, where only experienced users can locate. We might need a search button on the navbar. Best, Zhi > On Sep 26, 2019, at 9:24 AM, Anirudh Acharya wrote: > > Hi, > > In the operator tutorial( > http://mxnet.incubator.apache.org/api/faq/add_op_in_backend), there are > sections which do not render properly, for example - forward function, > backward function and shape inference. > > > Thanks > Anirudh > > > > > On Wed, Sep 25, 2019 at 7:53 AM Aaron Markham > wrote: > >> I'm seeing GA code is -1 not -11 in the analytics admin console. 11 >> was for beta.mxnet.io. >> Either way, the Jekyll prod config file was missing the GA code, so I >> added it with this PR: >> https://github.com/apache/incubator-mxnet/pull/16271 >> >> Reindexing of the site is being tracked here: >> https://issues.apache.org/jira/browse/INFRA-19144 >> >> .htaccess testing was hampered by it not working on staging. This was >> tracked here, and it looks like infra just patched staging so we can >> resume redirect testing: >> https://issues.apache.org/jira/browse/INFRA-19075 >> I have a CI pipeline for beta testing. If anyone wants to contribute >> to working on the redirects, you can use this pipeline to publish to >> the beta staging site. >> http://jenkins.mxnet-ci.amazon-ml.com/job/restricted-website-publish-beta/ >> I've distilled this information in this issue: >> https://github.com/apache/incubator-mxnet/issues/16273 >> I'd much rather have another contributor work on this since it will >> teach testing changes on the website, testing CI deployments to >> staging using your fork, previewing on staging, and finally deploying >> it to prod. I'm happy to help & guide along the way. >> >> (echoing Thomas) Please be sure to raise new issues in the repo, so we >> don't lose them in this thread. Also, more people can work on them. It >> would great if others can jump in and get familiar with the new site >> and start contributing patches. >> >> Cheers, >> Aaron >> >> On Wed, Sep 25, 2019 at 3:15 AM Thomas DELTEIL >> wrote: >>> >>> @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 >>> 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 >>> >>> >>>
Re: new website, docs code freeze
Hi, In the operator tutorial( http://mxnet.incubator.apache.org/api/faq/add_op_in_backend), there are sections which do not render properly, for example - forward function, backward function and shape inference. Thanks Anirudh On Wed, Sep 25, 2019 at 7:53 AM Aaron Markham wrote: > I'm seeing GA code is -1 not -11 in the analytics admin console. 11 > was for beta.mxnet.io. > Either way, the Jekyll prod config file was missing the GA code, so I > added it with this PR: > https://github.com/apache/incubator-mxnet/pull/16271 > > Reindexing of the site is being tracked here: > https://issues.apache.org/jira/browse/INFRA-19144 > > .htaccess testing was hampered by it not working on staging. This was > tracked here, and it looks like infra just patched staging so we can > resume redirect testing: > https://issues.apache.org/jira/browse/INFRA-19075 > I have a CI pipeline for beta testing. If anyone wants to contribute > to working on the redirects, you can use this pipeline to publish to > the beta staging site. > http://jenkins.mxnet-ci.amazon-ml.com/job/restricted-website-publish-beta/ > I've distilled this information in this issue: > https://github.com/apache/incubator-mxnet/issues/16273 > I'd much rather have another contributor work on this since it will > teach testing changes on the website, testing CI deployments to > staging using your fork, previewing on staging, and finally deploying > it to prod. I'm happy to help & guide along the way. > > (echoing Thomas) Please be sure to raise new issues in the repo, so we > don't lose them in this thread. Also, more people can work on them. It > would great if others can jump in and get familiar with the new site > and start contributing patches. > > Cheers, > Aaron > > On Wed, Sep 25, 2019 at 3:15 AM Thomas DELTEIL > wrote: > > > > @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 > > 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 > 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 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 >
Re: new website
I'm surprised we haven't properly announced such cool launch.
https://twitter.com/wikier/status/1176903475906482176
On Fri, Sep 6, 2019 at 12:32 PM Pedro Larroy
wrote:
> The new website looks great Aaron. Nice work to everyone involved !
>
> On Thu, Aug 29, 2019 at 5:26 PM Aaron Markham
> wrote:
>
> > Hi everyone,
> >
> > I'm very excited to share a preview and the pull requests for a new
> > website and new documentation pipelines.
> >
> > The following link is using Apache's new staging site setup. It is
> > built from the new docs publishing pipelines in CI where a Jekyll
> > website is built, and documentation artifacts from Clojure, CPP, Java,
> > Julia, Python, R, and Scala are combined into one website.
> >
> > https://mxnet-beta.staged.apache.org
> >
> > It is the culmination of a lot of effort of several MXNet contributors.
> >
> > * A huge shout out goes to Thomas Delteil for the work on the new
> > Jekyll-backend and beautiful-looking website, and for helping me out
> > whenever I'd get stuck on revamping the 7 different API docs systems
> > in CI.
> > * Soji Adeshina and Vishaal Kapoor both helping me with the system
> > design for the new docs pipelines.
> > * Per Goncalves da Silva and Marco de Abreu both helped me with
> > figuring out CI issues.
> > * We also ported over Mu Li's beta site for the Python & R APIs which
> > had many contributors there. Thanks goes to Mu, Ivy Bazan, Jonas
> > Mueller, Aston Zhang, and Zhi Zhang for their help & contributions. I
> > apologize in advance if I missed anyone.
> >
> > Highlights:
> >
> > * R docs are now generated as part of CI. There were issues with R
> > docs coming from beta repo. They were not reproducible. So I began the
> > process of creating the pdf doc that is expected by R users as an
> > alternative. Thomas fixed a CPP bug that was blocking 90% of the docs
> > from appearing. The R docs are 10x in length compared to the pdf we're
> > hosting now!
> >
> > * Each other API is built in a micro-site fashion. You will notice
> > that the reference API links will open up the site that is generated
> > by that language's docs tools. We tried to keep the navigation common
> > and do this for the Python API. This is something that can be expanded
> > on for the other APIs in later updates to the website.
> >
> > * Each doc set can be generated separately with functions that will
> > run in Docker and generate the docs artifacts. This means you can now
> > focus on your preferred API and not have to deal with anything else.
> >
> > * Website changes are now much easier. You can serve Jekyll locally,
> > and have it do incremental updates, so you can see your changes live
> > without having to build MXNet or anything else. It's a pure front-end
> > setup.
> >
> > * For website publishing, the MXNet binary is built once and then
> > shared with the other docs generation pipelines.
> >
> > * For individual docs runs, you can run a "lite" binary build, then
> > follow it up with the docs run you want.
> >
> > ---
> >
> > For example to build MXNet:
> >
> > ci/build.py --docker-registry mxnetcidev --platform ubuntu_cpu_lite
> > /work/runtime_functions.sh build_ubuntu_cpu_docs
> >
> > Then to build the R docs:
> >
> > ci/build.py --docker-registry mxnetcidev --platform ubuntu_cpu_r
> > /work/runtime_functions.sh build_r_docs
> >
> > There is now a Docker image and a runtime_function for each API
> > (except Perl which is built offsite). Python is like this:
> >
> > ci/build.py --docker-registry mxnetcidev --platform ubuntu_cpu_python
> > /work/runtime_functions.sh build_python_docs
> >
> > The pattern for platform is ubuntu_cpu_{api} and runtime_functions.sh
> > is build_{api}_docs.
> >
> > Further information is on the developer wiki:
> >
> https://cwiki.apache.org/confluence/display/MXNET/Building+the+New+Website
> >
> >
> > Ok, now this is where YOU come in. We need reviewers and testers.
> >
> > There are a lot of changes. My original PR was over 1,000 files with
> > 83k additions and 55k deletions. So, Thomas broke this up into three
> > pull requests that stack.
> >
> > Step 1 New Content https://github.com/apache/incubator-mxnet/pull/15884
> > Step 2 Remove Old Content
> > https://github.com/apache/incubator-mxnet/pull/15885
> > Step 3 Setup New Jenkins
> > https://github.com/apache/incubator-mxnet/pull/15886
> >
> > For reviewing purposes, start with the new content - what's easily
> > visible on the preview website. This is mostly happening in the first
> > PR:
> > https://github.com/apache/incubator-mxnet/pull/15884
> > You can also look at these helper PRs that show you the differences so
> > it is easier to review what's happening in Steps 2 and 3. You can
> > review these now as well.
> > Step 1->2: https://github.com/ThomasDelteil/incubator-mxnet/pull/5
> > Step 2->3: https://github.com/ThomasDelteil/incubator-mxnet/pull/6
> >
> > I really appreciate everyone's support on this effort.
> >
> > Cheers,
> > Aaron
> >
>
Re: new website, docs code freeze
I'm seeing GA code is -1 not -11 in the analytics admin console. 11 was for beta.mxnet.io. Either way, the Jekyll prod config file was missing the GA code, so I added it with this PR: https://github.com/apache/incubator-mxnet/pull/16271 Reindexing of the site is being tracked here: https://issues.apache.org/jira/browse/INFRA-19144 .htaccess testing was hampered by it not working on staging. This was tracked here, and it looks like infra just patched staging so we can resume redirect testing: https://issues.apache.org/jira/browse/INFRA-19075 I have a CI pipeline for beta testing. If anyone wants to contribute to working on the redirects, you can use this pipeline to publish to the beta staging site. http://jenkins.mxnet-ci.amazon-ml.com/job/restricted-website-publish-beta/ I've distilled this information in this issue: https://github.com/apache/incubator-mxnet/issues/16273 I'd much rather have another contributor work on this since it will teach testing changes on the website, testing CI deployments to staging using your fork, previewing on staging, and finally deploying it to prod. I'm happy to help & guide along the way. (echoing Thomas) Please be sure to raise new issues in the repo, so we don't lose them in this thread. Also, more people can work on them. It would great if others can jump in and get familiar with the new site and start contributing patches. Cheers, Aaron On Wed, Sep 25, 2019 at 3:15 AM Thomas DELTEIL wrote: > > @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 > 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 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 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 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] > >
Re: new website, docs code freeze
@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 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 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 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 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 > > >> 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 > > >>> > 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 > > >>> > >
Re: new website, docs code freeze
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 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 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 > > 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 > >> 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 > >>> > 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 > >>> wrote: > >>> > > > >>> > > > 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 > >>> > > > 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
Re: new website, docs code freeze
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 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 > 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 >> 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 >>> > 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 >>> > 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 >>> wrote: >>> > > >>> > > > 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 >>> > > > 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 i
Re: new website, docs code freeze
One possible fix is to create 301 redirects via .htaccess or mod_rewrite. Example: https://mxnet.incubator.apache.org/api/python/gluon/nn.html should be redirected to https://mxnet.incubator.apache.org/api/python/docs/api/gluon/nn.html On Tue, Sep 24, 2019 at 4:23 PM Marco de Abreu wrote: > Hi Philip, > > yeah that certainly makes sense. Keeping our links alive (and at least > avoid a 404) should be our highest priority. Do we have a strategy for this > and was that part of the website launch plan? > > Best regards, > Marco > > On Wed, Sep 25, 2019 at 1:20 AM Philip Cho > wrote: > > > Hi Marco: > > > > Today, I searched for "mxnet conv" and clicked on the first link (Gluon > > Neural Network Layers — mxnet documentation) and got a 404. > > I suppose documents have different URLs under the new doc system? This > may > > explain drop in traffic. > > > > Philip. > > > > On Tue, Sep 24, 2019 at 4:17 PM Marco de Abreu > > 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 > > > 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 > > >> > 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 > > >> wrote: > > >> > > > > >> > > > 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 > > >> > > > need > > >> > > > > to be resolved and introduce opportunity for errors > > >> > > > > - by releasing early, we can take advantage of the community > > >> > > > contributions > > >> > &g
Re: new website, docs code freeze
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 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 > 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 >> > 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 >> > 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 >> wrote: >> > > >> > > > 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 >> > > > 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
Re: new website, docs code freeze
Hi Philip, yeah that certainly makes sense. Keeping our links alive (and at least avoid a 404) should be our highest priority. Do we have a strategy for this and was that part of the website launch plan? Best regards, Marco On Wed, Sep 25, 2019 at 1:20 AM Philip Cho wrote: > Hi Marco: > > Today, I searched for "mxnet conv" and clicked on the first link (Gluon > Neural Network Layers — mxnet documentation) and got a 404. > I suppose documents have different URLs under the new doc system? This may > explain drop in traffic. > > Philip. > > On Tue, Sep 24, 2019 at 4:17 PM Marco de Abreu > 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 > > 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 > >> > 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 > > >> > 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 > >> wrote: > >> > > > >> > > > 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 > >> > > > 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 >
Re: new website, docs code freeze
Hi Marco: Today, I searched for "mxnet conv" and clicked on the first link (Gluon Neural Network Layers — mxnet documentation) and got a 404. I suppose documents have different URLs under the new doc system? This may explain drop in traffic. Philip. On Tue, Sep 24, 2019 at 4:17 PM Marco de Abreu 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 > 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 >> > 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 >> > 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 >> wrote: >> > > >> > > > 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 >> > > > 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
Re: new website, docs code freeze
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 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 > > 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 > > 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 wrote: > > > > > > > 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 > > > > 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
RE: new website, docs code freeze
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 > 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 > 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 wrote: > > > > > 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 > > > 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, thi
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 wrote: > Another issue I found with the current website: the Sphinx object inventory > <https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html> > 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 wrote: > > > 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 > > 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://m
Re: new website, docs code freeze
Another issue I found with the current website: the Sphinx object inventory <https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html> 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 wrote: > 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 > 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 se
Re: new website, docs code freeze
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 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 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
RE: new website, docs code freeze
Minor suggestion: I think we can add more in features page to attract the user and also highlight the differentiation of MXNet. Something like quantization, faster inference and training, horovod supporting, AMP, automatic fusion in the fly... http://mxnet.incubator.apache.org/features Thanks, --Patric > -Original Message- > From: Thomas DELTEIL > Sent: Saturday, September 21, 2019 12:29 PM > To: dev@mxnet.incubator.apache.org > Subject: Re: new website, docs code freeze > > 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. > > 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 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 > > wrote: > > > > > Thanks Aaron and the team for launching new website! > > > > > > 1. There's no
Re: new website, docs code freeze
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. 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 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 > 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 -> 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 > > 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 lin
Re: new website, docs code freeze
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 -> 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 > 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 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.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.
Re: new website, docs code freeze
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 -> 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 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 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.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/>
Re: new website, docs code freeze
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 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 > > 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 > > > > > 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 > > > > > >
Re: new website, docs code freeze
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 > 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 > > > 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 > > >
Re: new website, docs code freeze
Nice!!! Congrats everyone! On Fri, Sep 20, 2019 at 10:28 AM Aaron Markham 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 > 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 > 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 >
Re: new website, docs code freeze
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 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 > 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
Re: new website, docs code freeze
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 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
new website, docs code freeze
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
Re: new website
The new website looks great Aaron. Nice work to everyone involved !
On Thu, Aug 29, 2019 at 5:26 PM Aaron Markham
wrote:
> Hi everyone,
>
> I'm very excited to share a preview and the pull requests for a new
> website and new documentation pipelines.
>
> The following link is using Apache's new staging site setup. It is
> built from the new docs publishing pipelines in CI where a Jekyll
> website is built, and documentation artifacts from Clojure, CPP, Java,
> Julia, Python, R, and Scala are combined into one website.
>
> https://mxnet-beta.staged.apache.org
>
> It is the culmination of a lot of effort of several MXNet contributors.
>
> * A huge shout out goes to Thomas Delteil for the work on the new
> Jekyll-backend and beautiful-looking website, and for helping me out
> whenever I'd get stuck on revamping the 7 different API docs systems
> in CI.
> * Soji Adeshina and Vishaal Kapoor both helping me with the system
> design for the new docs pipelines.
> * Per Goncalves da Silva and Marco de Abreu both helped me with
> figuring out CI issues.
> * We also ported over Mu Li's beta site for the Python & R APIs which
> had many contributors there. Thanks goes to Mu, Ivy Bazan, Jonas
> Mueller, Aston Zhang, and Zhi Zhang for their help & contributions. I
> apologize in advance if I missed anyone.
>
> Highlights:
>
> * R docs are now generated as part of CI. There were issues with R
> docs coming from beta repo. They were not reproducible. So I began the
> process of creating the pdf doc that is expected by R users as an
> alternative. Thomas fixed a CPP bug that was blocking 90% of the docs
> from appearing. The R docs are 10x in length compared to the pdf we're
> hosting now!
>
> * Each other API is built in a micro-site fashion. You will notice
> that the reference API links will open up the site that is generated
> by that language's docs tools. We tried to keep the navigation common
> and do this for the Python API. This is something that can be expanded
> on for the other APIs in later updates to the website.
>
> * Each doc set can be generated separately with functions that will
> run in Docker and generate the docs artifacts. This means you can now
> focus on your preferred API and not have to deal with anything else.
>
> * Website changes are now much easier. You can serve Jekyll locally,
> and have it do incremental updates, so you can see your changes live
> without having to build MXNet or anything else. It's a pure front-end
> setup.
>
> * For website publishing, the MXNet binary is built once and then
> shared with the other docs generation pipelines.
>
> * For individual docs runs, you can run a "lite" binary build, then
> follow it up with the docs run you want.
>
> ---
>
> For example to build MXNet:
>
> ci/build.py --docker-registry mxnetcidev --platform ubuntu_cpu_lite
> /work/runtime_functions.sh build_ubuntu_cpu_docs
>
> Then to build the R docs:
>
> ci/build.py --docker-registry mxnetcidev --platform ubuntu_cpu_r
> /work/runtime_functions.sh build_r_docs
>
> There is now a Docker image and a runtime_function for each API
> (except Perl which is built offsite). Python is like this:
>
> ci/build.py --docker-registry mxnetcidev --platform ubuntu_cpu_python
> /work/runtime_functions.sh build_python_docs
>
> The pattern for platform is ubuntu_cpu_{api} and runtime_functions.sh
> is build_{api}_docs.
>
> Further information is on the developer wiki:
> https://cwiki.apache.org/confluence/display/MXNET/Building+the+New+Website
>
>
> Ok, now this is where YOU come in. We need reviewers and testers.
>
> There are a lot of changes. My original PR was over 1,000 files with
> 83k additions and 55k deletions. So, Thomas broke this up into three
> pull requests that stack.
>
> Step 1 New Content https://github.com/apache/incubator-mxnet/pull/15884
> Step 2 Remove Old Content
> https://github.com/apache/incubator-mxnet/pull/15885
> Step 3 Setup New Jenkins
> https://github.com/apache/incubator-mxnet/pull/15886
>
> For reviewing purposes, start with the new content - what's easily
> visible on the preview website. This is mostly happening in the first
> PR:
> https://github.com/apache/incubator-mxnet/pull/15884
> You can also look at these helper PRs that show you the differences so
> it is easier to review what's happening in Steps 2 and 3. You can
> review these now as well.
> Step 1->2: https://github.com/ThomasDelteil/incubator-mxnet/pull/5
> Step 2->3: https://github.com/ThomasDelteil/incubator-mxnet/pull/6
>
> I really appreciate everyone's support on this effort.
>
> Cheers,
> Aaron
>
Re: new website
Thanks for the feedback. We're starting to see merge conflicts as our base is wandering off from master. The PRs are pretty massive, and there's a lot of moving parts. I'd really appreciate reviews, so we can move forward. The first PR only ADDs content and gives us the new site. Having the new content in there would allow for people to add suggestions and even cut PRs to fix cosmetic (like the dropdown) or content issues. The second PR deletes things, but the 3rd PR sweeps up the publishing and CI processes that are removed in the 2nd PR. It pretty difficult to test all of these things, as I have made improvements in CI that I can't easily use to test the new site material in the 1st PR. An alternate strategy is to add the new site, add the new CI functionality, then cleanup. But... this has the drawback on not making a clean break and potentially leaving a bunch of mess in repo that never gets deleted. I feel that a clean repo is better. And we can always go back and restore stuff that we actually needed. On Fri, Aug 30, 2019 at 7:23 PM Chaitanya Bapat wrote: > > First things first, > > Big shout out to you (Aaron) and the team for laying a strong foundation > for the new website! We all knew that our original website needed > improvements and it's criticality for user adoption and growth. But doing > it well and in a timely manner. Great job, keep it up. > > Those 3 PRs are pretty massive. But would still try to review it by > this weekend. PR descriptions were helpful in knowing what's happening > amidst a lot of chaos. > > Nitpick: Aside from the known issues highlighted in the first PR [1/3], I > found the MXNet version selection via the dropdown to be odd (Main page -> > Getting started) Is there a cleaner way of doing this? > > Thanks once again. > > > On Thu, 29 Aug 2019 at 18:06, Yuan Tang wrote: > > > I think for now PDF would still be used by a good amount of users since R > > users are used to read PDF manual for packages that don't have websites. > > > > Nowadays Github pages + pkgdown combination is getting more and more > > popular so we would see a trend soon towards web hosted docs for R > > packages. > > > > On Thu, Aug 29, 2019 at 8:58 PM Aaron Markham > > wrote: > > > > > pkgdown makes some nice looking R microsites. Good idea. Do you know > > > if many R users would still want the pdf or have things moved to use > > > websites for reference like this? > > > One of the nice things about the new pipelines for docs is that > > > they're not wrapped by Sphinx, so our R contributors will have an > > > easier time testing and adding this kind of feature. > > > > > > On Thu, Aug 29, 2019 at 5:34 PM Yuan Tang > > wrote: > > > > > > > > Thanks for the update, Aaron. > > > > > > > > Regarding the R docs, one suggestion I have is to use pkgdown package ( > > > > https://pkgdown.r-lib.org/index.html) to automatically generated the > > > > documentation pages (tutorials, API reference, etc.). I've seen huge > > > > adoption of this package being used for documentations in the R > > > community. > > > > > > > > > > > > On Thu, Aug 29, 2019 at 8:26 PM Aaron Markham < > > aaron.s.mark...@gmail.com > > > > > > > > wrote: > > > > > > > > > Hi everyone, > > > > > > > > > > I'm very excited to share a preview and the pull requests for a new > > > > > website and new documentation pipelines. > > > > > > > > > > The following link is using Apache's new staging site setup. It is > > > > > built from the new docs publishing pipelines in CI where a Jekyll > > > > > website is built, and documentation artifacts from Clojure, CPP, > > Java, > > > > > Julia, Python, R, and Scala are combined into one website. > > > > > > > > > > https://mxnet-beta.staged.apache.org > > > > > > > > > > It is the culmination of a lot of effort of several MXNet > > contributors. > > > > > > > > > > * A huge shout out goes to Thomas Delteil for the work on the new > > > > > Jekyll-backend and beautiful-looking website, and for helping me out > > > > > whenever I'd get stuck on revamping the 7 different API docs systems > > > > > in CI. > > > > > * Soji Adeshina and Vishaal Kapoor both helping me with the system > > > > > design for the new docs pipelines. > > > > > * Per Goncalves da Silva and Marco de Abreu both helped me with
Re: new website
First things first, Big shout out to you (Aaron) and the team for laying a strong foundation for the new website! We all knew that our original website needed improvements and it's criticality for user adoption and growth. But doing it well and in a timely manner. Great job, keep it up. Those 3 PRs are pretty massive. But would still try to review it by this weekend. PR descriptions were helpful in knowing what's happening amidst a lot of chaos. Nitpick: Aside from the known issues highlighted in the first PR [1/3], I found the MXNet version selection via the dropdown to be odd (Main page -> Getting started) Is there a cleaner way of doing this? Thanks once again. On Thu, 29 Aug 2019 at 18:06, Yuan Tang wrote: > I think for now PDF would still be used by a good amount of users since R > users are used to read PDF manual for packages that don't have websites. > > Nowadays Github pages + pkgdown combination is getting more and more > popular so we would see a trend soon towards web hosted docs for R > packages. > > On Thu, Aug 29, 2019 at 8:58 PM Aaron Markham > wrote: > > > pkgdown makes some nice looking R microsites. Good idea. Do you know > > if many R users would still want the pdf or have things moved to use > > websites for reference like this? > > One of the nice things about the new pipelines for docs is that > > they're not wrapped by Sphinx, so our R contributors will have an > > easier time testing and adding this kind of feature. > > > > On Thu, Aug 29, 2019 at 5:34 PM Yuan Tang > wrote: > > > > > > Thanks for the update, Aaron. > > > > > > Regarding the R docs, one suggestion I have is to use pkgdown package ( > > > https://pkgdown.r-lib.org/index.html) to automatically generated the > > > documentation pages (tutorials, API reference, etc.). I've seen huge > > > adoption of this package being used for documentations in the R > > community. > > > > > > > > > On Thu, Aug 29, 2019 at 8:26 PM Aaron Markham < > aaron.s.mark...@gmail.com > > > > > > wrote: > > > > > > > Hi everyone, > > > > > > > > I'm very excited to share a preview and the pull requests for a new > > > > website and new documentation pipelines. > > > > > > > > The following link is using Apache's new staging site setup. It is > > > > built from the new docs publishing pipelines in CI where a Jekyll > > > > website is built, and documentation artifacts from Clojure, CPP, > Java, > > > > Julia, Python, R, and Scala are combined into one website. > > > > > > > > https://mxnet-beta.staged.apache.org > > > > > > > > It is the culmination of a lot of effort of several MXNet > contributors. > > > > > > > > * A huge shout out goes to Thomas Delteil for the work on the new > > > > Jekyll-backend and beautiful-looking website, and for helping me out > > > > whenever I'd get stuck on revamping the 7 different API docs systems > > > > in CI. > > > > * Soji Adeshina and Vishaal Kapoor both helping me with the system > > > > design for the new docs pipelines. > > > > * Per Goncalves da Silva and Marco de Abreu both helped me with > > > > figuring out CI issues. > > > > * We also ported over Mu Li's beta site for the Python & R APIs which > > > > had many contributors there. Thanks goes to Mu, Ivy Bazan, Jonas > > > > Mueller, Aston Zhang, and Zhi Zhang for their help & contributions. I > > > > apologize in advance if I missed anyone. > > > > > > > > Highlights: > > > > > > > > * R docs are now generated as part of CI. There were issues with R > > > > docs coming from beta repo. They were not reproducible. So I began > the > > > > process of creating the pdf doc that is expected by R users as an > > > > alternative. Thomas fixed a CPP bug that was blocking 90% of the docs > > > > from appearing. The R docs are 10x in length compared to the pdf > we're > > > > hosting now! > > > > > > > > * Each other API is built in a micro-site fashion. You will notice > > > > that the reference API links will open up the site that is generated > > > > by that language's docs tools. We tried to keep the navigation common > > > > and do this for the Python API. This is something that can be > expanded > > > > on for the other APIs in later updates to the website. > > > > > > > &
Re: new website
I think for now PDF would still be used by a good amount of users since R users are used to read PDF manual for packages that don't have websites. Nowadays Github pages + pkgdown combination is getting more and more popular so we would see a trend soon towards web hosted docs for R packages. On Thu, Aug 29, 2019 at 8:58 PM Aaron Markham wrote: > pkgdown makes some nice looking R microsites. Good idea. Do you know > if many R users would still want the pdf or have things moved to use > websites for reference like this? > One of the nice things about the new pipelines for docs is that > they're not wrapped by Sphinx, so our R contributors will have an > easier time testing and adding this kind of feature. > > On Thu, Aug 29, 2019 at 5:34 PM Yuan Tang wrote: > > > > Thanks for the update, Aaron. > > > > Regarding the R docs, one suggestion I have is to use pkgdown package ( > > https://pkgdown.r-lib.org/index.html) to automatically generated the > > documentation pages (tutorials, API reference, etc.). I've seen huge > > adoption of this package being used for documentations in the R > community. > > > > > > On Thu, Aug 29, 2019 at 8:26 PM Aaron Markham > > > wrote: > > > > > Hi everyone, > > > > > > I'm very excited to share a preview and the pull requests for a new > > > website and new documentation pipelines. > > > > > > The following link is using Apache's new staging site setup. It is > > > built from the new docs publishing pipelines in CI where a Jekyll > > > website is built, and documentation artifacts from Clojure, CPP, Java, > > > Julia, Python, R, and Scala are combined into one website. > > > > > > https://mxnet-beta.staged.apache.org > > > > > > It is the culmination of a lot of effort of several MXNet contributors. > > > > > > * A huge shout out goes to Thomas Delteil for the work on the new > > > Jekyll-backend and beautiful-looking website, and for helping me out > > > whenever I'd get stuck on revamping the 7 different API docs systems > > > in CI. > > > * Soji Adeshina and Vishaal Kapoor both helping me with the system > > > design for the new docs pipelines. > > > * Per Goncalves da Silva and Marco de Abreu both helped me with > > > figuring out CI issues. > > > * We also ported over Mu Li's beta site for the Python & R APIs which > > > had many contributors there. Thanks goes to Mu, Ivy Bazan, Jonas > > > Mueller, Aston Zhang, and Zhi Zhang for their help & contributions. I > > > apologize in advance if I missed anyone. > > > > > > Highlights: > > > > > > * R docs are now generated as part of CI. There were issues with R > > > docs coming from beta repo. They were not reproducible. So I began the > > > process of creating the pdf doc that is expected by R users as an > > > alternative. Thomas fixed a CPP bug that was blocking 90% of the docs > > > from appearing. The R docs are 10x in length compared to the pdf we're > > > hosting now! > > > > > > * Each other API is built in a micro-site fashion. You will notice > > > that the reference API links will open up the site that is generated > > > by that language's docs tools. We tried to keep the navigation common > > > and do this for the Python API. This is something that can be expanded > > > on for the other APIs in later updates to the website. > > > > > > * Each doc set can be generated separately with functions that will > > > run in Docker and generate the docs artifacts. This means you can now > > > focus on your preferred API and not have to deal with anything else. > > > > > > * Website changes are now much easier. You can serve Jekyll locally, > > > and have it do incremental updates, so you can see your changes live > > > without having to build MXNet or anything else. It's a pure front-end > > > setup. > > > > > > * For website publishing, the MXNet binary is built once and then > > > shared with the other docs generation pipelines. > > > > > > * For individual docs runs, you can run a "lite" binary build, then > > > follow it up with the docs run you want. > > > > > > --- > > > > > > For example to build MXNet: > > > > > > ci/build.py --docker-registry mxnetcidev --platform ubuntu_cpu_lite > > > /work/runtime_functions.sh build_ubuntu_cpu_docs > > > > > > Then to build the R docs: > > > > > >
Re: new website
pkgdown makes some nice looking R microsites. Good idea. Do you know
if many R users would still want the pdf or have things moved to use
websites for reference like this?
One of the nice things about the new pipelines for docs is that
they're not wrapped by Sphinx, so our R contributors will have an
easier time testing and adding this kind of feature.
On Thu, Aug 29, 2019 at 5:34 PM Yuan Tang wrote:
>
> Thanks for the update, Aaron.
>
> Regarding the R docs, one suggestion I have is to use pkgdown package (
> https://pkgdown.r-lib.org/index.html) to automatically generated the
> documentation pages (tutorials, API reference, etc.). I've seen huge
> adoption of this package being used for documentations in the R community.
>
>
> On Thu, Aug 29, 2019 at 8:26 PM Aaron Markham
> wrote:
>
> > Hi everyone,
> >
> > I'm very excited to share a preview and the pull requests for a new
> > website and new documentation pipelines.
> >
> > The following link is using Apache's new staging site setup. It is
> > built from the new docs publishing pipelines in CI where a Jekyll
> > website is built, and documentation artifacts from Clojure, CPP, Java,
> > Julia, Python, R, and Scala are combined into one website.
> >
> > https://mxnet-beta.staged.apache.org
> >
> > It is the culmination of a lot of effort of several MXNet contributors.
> >
> > * A huge shout out goes to Thomas Delteil for the work on the new
> > Jekyll-backend and beautiful-looking website, and for helping me out
> > whenever I'd get stuck on revamping the 7 different API docs systems
> > in CI.
> > * Soji Adeshina and Vishaal Kapoor both helping me with the system
> > design for the new docs pipelines.
> > * Per Goncalves da Silva and Marco de Abreu both helped me with
> > figuring out CI issues.
> > * We also ported over Mu Li's beta site for the Python & R APIs which
> > had many contributors there. Thanks goes to Mu, Ivy Bazan, Jonas
> > Mueller, Aston Zhang, and Zhi Zhang for their help & contributions. I
> > apologize in advance if I missed anyone.
> >
> > Highlights:
> >
> > * R docs are now generated as part of CI. There were issues with R
> > docs coming from beta repo. They were not reproducible. So I began the
> > process of creating the pdf doc that is expected by R users as an
> > alternative. Thomas fixed a CPP bug that was blocking 90% of the docs
> > from appearing. The R docs are 10x in length compared to the pdf we're
> > hosting now!
> >
> > * Each other API is built in a micro-site fashion. You will notice
> > that the reference API links will open up the site that is generated
> > by that language's docs tools. We tried to keep the navigation common
> > and do this for the Python API. This is something that can be expanded
> > on for the other APIs in later updates to the website.
> >
> > * Each doc set can be generated separately with functions that will
> > run in Docker and generate the docs artifacts. This means you can now
> > focus on your preferred API and not have to deal with anything else.
> >
> > * Website changes are now much easier. You can serve Jekyll locally,
> > and have it do incremental updates, so you can see your changes live
> > without having to build MXNet or anything else. It's a pure front-end
> > setup.
> >
> > * For website publishing, the MXNet binary is built once and then
> > shared with the other docs generation pipelines.
> >
> > * For individual docs runs, you can run a "lite" binary build, then
> > follow it up with the docs run you want.
> >
> > ---
> >
> > For example to build MXNet:
> >
> > ci/build.py --docker-registry mxnetcidev --platform ubuntu_cpu_lite
> > /work/runtime_functions.sh build_ubuntu_cpu_docs
> >
> > Then to build the R docs:
> >
> > ci/build.py --docker-registry mxnetcidev --platform ubuntu_cpu_r
> > /work/runtime_functions.sh build_r_docs
> >
> > There is now a Docker image and a runtime_function for each API
> > (except Perl which is built offsite). Python is like this:
> >
> > ci/build.py --docker-registry mxnetcidev --platform ubuntu_cpu_python
> > /work/runtime_functions.sh build_python_docs
> >
> > The pattern for platform is ubuntu_cpu_{api} and runtime_functions.sh
> > is build_{api}_docs.
> >
> > Further information is on the developer wiki:
> > https://cwiki.apache.org/confluence/display/MXNET/Building+the+New+Website
> >
> >
> > Ok, now this is where YOU come in. We need reviewers and testers.
> >
> &
Re: new website
Thanks for the update, Aaron.
Regarding the R docs, one suggestion I have is to use pkgdown package (
https://pkgdown.r-lib.org/index.html) to automatically generated the
documentation pages (tutorials, API reference, etc.). I've seen huge
adoption of this package being used for documentations in the R community.
On Thu, Aug 29, 2019 at 8:26 PM Aaron Markham
wrote:
> Hi everyone,
>
> I'm very excited to share a preview and the pull requests for a new
> website and new documentation pipelines.
>
> The following link is using Apache's new staging site setup. It is
> built from the new docs publishing pipelines in CI where a Jekyll
> website is built, and documentation artifacts from Clojure, CPP, Java,
> Julia, Python, R, and Scala are combined into one website.
>
> https://mxnet-beta.staged.apache.org
>
> It is the culmination of a lot of effort of several MXNet contributors.
>
> * A huge shout out goes to Thomas Delteil for the work on the new
> Jekyll-backend and beautiful-looking website, and for helping me out
> whenever I'd get stuck on revamping the 7 different API docs systems
> in CI.
> * Soji Adeshina and Vishaal Kapoor both helping me with the system
> design for the new docs pipelines.
> * Per Goncalves da Silva and Marco de Abreu both helped me with
> figuring out CI issues.
> * We also ported over Mu Li's beta site for the Python & R APIs which
> had many contributors there. Thanks goes to Mu, Ivy Bazan, Jonas
> Mueller, Aston Zhang, and Zhi Zhang for their help & contributions. I
> apologize in advance if I missed anyone.
>
> Highlights:
>
> * R docs are now generated as part of CI. There were issues with R
> docs coming from beta repo. They were not reproducible. So I began the
> process of creating the pdf doc that is expected by R users as an
> alternative. Thomas fixed a CPP bug that was blocking 90% of the docs
> from appearing. The R docs are 10x in length compared to the pdf we're
> hosting now!
>
> * Each other API is built in a micro-site fashion. You will notice
> that the reference API links will open up the site that is generated
> by that language's docs tools. We tried to keep the navigation common
> and do this for the Python API. This is something that can be expanded
> on for the other APIs in later updates to the website.
>
> * Each doc set can be generated separately with functions that will
> run in Docker and generate the docs artifacts. This means you can now
> focus on your preferred API and not have to deal with anything else.
>
> * Website changes are now much easier. You can serve Jekyll locally,
> and have it do incremental updates, so you can see your changes live
> without having to build MXNet or anything else. It's a pure front-end
> setup.
>
> * For website publishing, the MXNet binary is built once and then
> shared with the other docs generation pipelines.
>
> * For individual docs runs, you can run a "lite" binary build, then
> follow it up with the docs run you want.
>
> ---
>
> For example to build MXNet:
>
> ci/build.py --docker-registry mxnetcidev --platform ubuntu_cpu_lite
> /work/runtime_functions.sh build_ubuntu_cpu_docs
>
> Then to build the R docs:
>
> ci/build.py --docker-registry mxnetcidev --platform ubuntu_cpu_r
> /work/runtime_functions.sh build_r_docs
>
> There is now a Docker image and a runtime_function for each API
> (except Perl which is built offsite). Python is like this:
>
> ci/build.py --docker-registry mxnetcidev --platform ubuntu_cpu_python
> /work/runtime_functions.sh build_python_docs
>
> The pattern for platform is ubuntu_cpu_{api} and runtime_functions.sh
> is build_{api}_docs.
>
> Further information is on the developer wiki:
> https://cwiki.apache.org/confluence/display/MXNET/Building+the+New+Website
>
>
> Ok, now this is where YOU come in. We need reviewers and testers.
>
> There are a lot of changes. My original PR was over 1,000 files with
> 83k additions and 55k deletions. So, Thomas broke this up into three
> pull requests that stack.
>
> Step 1 New Content https://github.com/apache/incubator-mxnet/pull/15884
> Step 2 Remove Old Content
> https://github.com/apache/incubator-mxnet/pull/15885
> Step 3 Setup New Jenkins
> https://github.com/apache/incubator-mxnet/pull/15886
>
> For reviewing purposes, start with the new content - what's easily
> visible on the preview website. This is mostly happening in the first
> PR:
> https://github.com/apache/incubator-mxnet/pull/15884
> You can also look at these helper PRs that show you the differences so
> it is easier to review what's happening in Steps 2 and 3. You can
> review these now as well.
> Step 1->2: https://github.com/ThomasDelteil/incubator-mxnet/pull/5
> Step 2->3: https://github.com/ThomasDelteil/incubator-mxnet/pull/6
>
> I really appreciate everyone's support on this effort.
>
> Cheers,
> Aaron
>
new website
Hi everyone,
I'm very excited to share a preview and the pull requests for a new
website and new documentation pipelines.
The following link is using Apache's new staging site setup. It is
built from the new docs publishing pipelines in CI where a Jekyll
website is built, and documentation artifacts from Clojure, CPP, Java,
Julia, Python, R, and Scala are combined into one website.
https://mxnet-beta.staged.apache.org
It is the culmination of a lot of effort of several MXNet contributors.
* A huge shout out goes to Thomas Delteil for the work on the new
Jekyll-backend and beautiful-looking website, and for helping me out
whenever I'd get stuck on revamping the 7 different API docs systems
in CI.
* Soji Adeshina and Vishaal Kapoor both helping me with the system
design for the new docs pipelines.
* Per Goncalves da Silva and Marco de Abreu both helped me with
figuring out CI issues.
* We also ported over Mu Li's beta site for the Python & R APIs which
had many contributors there. Thanks goes to Mu, Ivy Bazan, Jonas
Mueller, Aston Zhang, and Zhi Zhang for their help & contributions. I
apologize in advance if I missed anyone.
Highlights:
* R docs are now generated as part of CI. There were issues with R
docs coming from beta repo. They were not reproducible. So I began the
process of creating the pdf doc that is expected by R users as an
alternative. Thomas fixed a CPP bug that was blocking 90% of the docs
from appearing. The R docs are 10x in length compared to the pdf we're
hosting now!
* Each other API is built in a micro-site fashion. You will notice
that the reference API links will open up the site that is generated
by that language's docs tools. We tried to keep the navigation common
and do this for the Python API. This is something that can be expanded
on for the other APIs in later updates to the website.
* Each doc set can be generated separately with functions that will
run in Docker and generate the docs artifacts. This means you can now
focus on your preferred API and not have to deal with anything else.
* Website changes are now much easier. You can serve Jekyll locally,
and have it do incremental updates, so you can see your changes live
without having to build MXNet or anything else. It's a pure front-end
setup.
* For website publishing, the MXNet binary is built once and then
shared with the other docs generation pipelines.
* For individual docs runs, you can run a "lite" binary build, then
follow it up with the docs run you want.
---
For example to build MXNet:
ci/build.py --docker-registry mxnetcidev --platform ubuntu_cpu_lite
/work/runtime_functions.sh build_ubuntu_cpu_docs
Then to build the R docs:
ci/build.py --docker-registry mxnetcidev --platform ubuntu_cpu_r
/work/runtime_functions.sh build_r_docs
There is now a Docker image and a runtime_function for each API
(except Perl which is built offsite). Python is like this:
ci/build.py --docker-registry mxnetcidev --platform ubuntu_cpu_python
/work/runtime_functions.sh build_python_docs
The pattern for platform is ubuntu_cpu_{api} and runtime_functions.sh
is build_{api}_docs.
Further information is on the developer wiki:
https://cwiki.apache.org/confluence/display/MXNET/Building+the+New+Website
Ok, now this is where YOU come in. We need reviewers and testers.
There are a lot of changes. My original PR was over 1,000 files with
83k additions and 55k deletions. So, Thomas broke this up into three
pull requests that stack.
Step 1 New Content https://github.com/apache/incubator-mxnet/pull/15884
Step 2 Remove Old Content https://github.com/apache/incubator-mxnet/pull/15885
Step 3 Setup New Jenkins https://github.com/apache/incubator-mxnet/pull/15886
For reviewing purposes, start with the new content - what's easily
visible on the preview website. This is mostly happening in the first
PR:
https://github.com/apache/incubator-mxnet/pull/15884
You can also look at these helper PRs that show you the differences so
it is easier to review what's happening in Steps 2 and 3. You can
review these now as well.
Step 1->2: https://github.com/ThomasDelteil/incubator-mxnet/pull/5
Step 2->3: https://github.com/ThomasDelteil/incubator-mxnet/pull/6
I really appreciate everyone's support on this effort.
Cheers,
Aaron
Re: new website (RE: CI and PRs)
the workspace being scoped to the correct branch. As a rule of > thumb > > it's basically a red flag as soon as you call anything with regards to > git > > (e.g. checking out a different branch, creating a commit, merging another > > branch, etc) within your payload. Happy to help if you would like to have > > that elaborated. > > > > * Could you elaborate on "Publishing scripts seem to need a security > > refactor, or we don't bother offering stand-alone access to them; running > > local versus on Jenkins."? I don't really understand what you mean here. > > > > * Basically it's an s3 bucket with a TTL of 30 days that our CI slaves > have > > permission to push to. We basically just upload the entire folder that is > > being created. Is there anything specifically you're looking for? > > > > * That's awesome! > > > > Best regards, > > Marco > > > > On Thu, Aug 15, 2019 at 8:52 PM Aaron Markham > > > wrote: > > > > > I'll start a different thread about the website. Sure, there's a lot > > > of overlap with CI. I learned a lot in the last few weeks having to > > > iterate on 7 different docs packages and trying to streamline the > > > build process in CI. > > > > > > Here are my notes: > > > > > > * Stash operations vs. archiving - recommendations in the docs suggest > > > that large artifacts should be archived; stash is super slow; archived > > > artifacts seems to be faster and can be used between pipelines. This > > > is helpful for the MXNet binary and for the Scala package, both of > > > which are used by various other docs packages. However, there's an > > > implication with the master server. Archived artifacts are stored > > > there, so if the pipeline is related to PR validation, this would be > > > unwieldy. If related to publishing final artifacts for specific > > > versions, well, that's probably ok. > > > > > > * It seems that efficiency in development and testing can be gained by > > > checkpointing the docker containers after the dependencies are > > > installed. I can't stress how much time is lost while watching > > > `apt-get update` run for the millionth time when testing new CI > > > routines. It sort of makes me crazy(er). > > > > > > * A version/branch parameter would be useful for the Jenkins pipelines > > > for generating docs artifacts from different branches. > > > > > > * Publishing scripts seem to need a security refactor, or we don't > > > bother offering stand-alone access to them; running local versus on > > > Jenkins. > > > > > > * I don't see any documentation on the S3 publishing steps and how to > test > > > this. > > > > > > * After breaking out each docs package in its own pipeline, I see > > > opportunities to use the GitHub API to check the PR payload and be > > > selective about what tests to run. > > > > > > > > > On Wed, Aug 14, 2019 at 10:03 PM Zhao, Patric > > > wrote: > > > > > > > > Hi Aaron, > > > > > > > > Recently, we are working on improving the documents of CPU backend > based > > > on the current website. > > > > > > > > I saw there're several PRs to update the new website and it's really > > > great. > > > > > > > > Thus, I'd like to know when the new website will online. > > > > If it's very near, we will switch our works to the new website. > > > > > > > > Thanks, > > > > > > > > --Patric > > > > > > > > > > > > > -Original Message- > > > > > From: Aaron Markham > > > > > Sent: Thursday, August 15, 2019 11:40 AM > > > > > To: dev@mxnet.incubator.apache.org > > > > > Subject: Re: CI and PRs > > > > > > > > > > The PRs Thomas and I are working on for the new docs and website > share > > > > > the mxnet binary in the new CI pipelines we made. Speeds things up > a > > > lot. > > > > > > > > > > On Wed, Aug 14, 2019, 18:16 Chris Olivier > > > wrote: > > > > > > > > > > > I see it done daily now, and while I can’t share all the details, > > > it’s > > > > > > not an incredibly complex thing, and involves not much more than > > > > > > nfs/efs sharing and remote ssh commands
Re: new website (RE: CI and PRs)
d. I can't stress how much time is lost while watching > > `apt-get update` run for the millionth time when testing new CI > > routines. It sort of makes me crazy(er). > > > > * A version/branch parameter would be useful for the Jenkins pipelines > > for generating docs artifacts from different branches. > > > > * Publishing scripts seem to need a security refactor, or we don't > > bother offering stand-alone access to them; running local versus on > > Jenkins. > > > > * I don't see any documentation on the S3 publishing steps and how to test > > this. > > > > * After breaking out each docs package in its own pipeline, I see > > opportunities to use the GitHub API to check the PR payload and be > > selective about what tests to run. > > > > > > On Wed, Aug 14, 2019 at 10:03 PM Zhao, Patric > > wrote: > > > > > > Hi Aaron, > > > > > > Recently, we are working on improving the documents of CPU backend based > > on the current website. > > > > > > I saw there're several PRs to update the new website and it's really > > great. > > > > > > Thus, I'd like to know when the new website will online. > > > If it's very near, we will switch our works to the new website. > > > > > > Thanks, > > > > > > --Patric > > > > > > > > > > -Original Message- > > > > From: Aaron Markham > > > > Sent: Thursday, August 15, 2019 11:40 AM > > > > To: dev@mxnet.incubator.apache.org > > > > Subject: Re: CI and PRs > > > > > > > > The PRs Thomas and I are working on for the new docs and website share > > > > the mxnet binary in the new CI pipelines we made. Speeds things up a > > lot. > > > > > > > > On Wed, Aug 14, 2019, 18:16 Chris Olivier > > wrote: > > > > > > > > > I see it done daily now, and while I can’t share all the details, > > it’s > > > > > not an incredibly complex thing, and involves not much more than > > > > > nfs/efs sharing and remote ssh commands. All it takes is a little > > > > > ingenuity and some imagination. > > > > > > > > > > On Wed, Aug 14, 2019 at 4:31 PM Pedro Larroy > > > > > > > > > > > > > > > wrote: > > > > > > > > > > > Sounds good in theory. I think there are complex details with > > > > > > regards of resource sharing during parallel execution. Still I > > think > > > > > > both ways can > > > > > be > > > > > > explored. I think some tests run for unreasonably long times for > > > > > > what > > > > > they > > > > > > are doing. We already scale parts of the pipeline horizontally > > > > > > across workers. > > > > > > > > > > > > > > > > > > On Wed, Aug 14, 2019 at 5:12 PM Chris Olivier > > > > > > > > > > > > wrote: > > > > > > > > > > > > > +1 > > > > > > > > > > > > > > Rather than remove tests (which doesn’t scale as a solution), why > > > > > > > not > > > > > > scale > > > > > > > them horizontally so that they finish more quickly? Across > > > > > > > processes or even on a pool of machines that aren’t necessarily > > the > > > > build machine? > > > > > > > > > > > > > > On Wed, Aug 14, 2019 at 12:03 PM Marco de Abreu < > > > > > marco.g.ab...@gmail.com > > > > > > > > > > > > > > wrote: > > > > > > > > > > > > > > > With regards to time I rather prefer us spending a bit more > > time > > > > > > > > on maintenance than somebody running into an error that > > could've > > > > > > > > been > > > > > > caught > > > > > > > > with a test. > > > > > > > > > > > > > > > > I mean, our Publishing pipeline for Scala GPU has been broken > > > > > > > > for > > > > > quite > > > > > > > > some time now, but nobody noticed that. Basically my stance on > > > > > > > > that > > > > > > > matter > > > &g
Re: new website (RE: CI and PRs)
Hi, thanks a lot for these great notes! I'm happy to give my comments about them :) * Archiving is *very VERY* bad for the CI master performance. It floods the disk with data since archiving persists the data. We are now at the point where we technically can't extend the volume any further (we exceeded the 4TB limit and had to delete old runs). Thus, stashing is the only option that's not harmful to the systems performance. * Yeah, agree. One way is to build a Dockerfile, push it to your own Dockerhub account and then in the MXNet DOckerfile just make "FROM yourdockerhub:blabla". * We support the GitHub Multi-Branch Pipeline and basically use this across all jobs. So adhering to that system will result in the git repository within the workspace being scoped to the correct branch. As a rule of thumb it's basically a red flag as soon as you call anything with regards to git (e.g. checking out a different branch, creating a commit, merging another branch, etc) within your payload. Happy to help if you would like to have that elaborated. * Could you elaborate on "Publishing scripts seem to need a security refactor, or we don't bother offering stand-alone access to them; running local versus on Jenkins."? I don't really understand what you mean here. * Basically it's an s3 bucket with a TTL of 30 days that our CI slaves have permission to push to. We basically just upload the entire folder that is being created. Is there anything specifically you're looking for? * That's awesome! Best regards, Marco On Thu, Aug 15, 2019 at 8:52 PM Aaron Markham wrote: > I'll start a different thread about the website. Sure, there's a lot > of overlap with CI. I learned a lot in the last few weeks having to > iterate on 7 different docs packages and trying to streamline the > build process in CI. > > Here are my notes: > > * Stash operations vs. archiving - recommendations in the docs suggest > that large artifacts should be archived; stash is super slow; archived > artifacts seems to be faster and can be used between pipelines. This > is helpful for the MXNet binary and for the Scala package, both of > which are used by various other docs packages. However, there's an > implication with the master server. Archived artifacts are stored > there, so if the pipeline is related to PR validation, this would be > unwieldy. If related to publishing final artifacts for specific > versions, well, that's probably ok. > > * It seems that efficiency in development and testing can be gained by > checkpointing the docker containers after the dependencies are > installed. I can't stress how much time is lost while watching > `apt-get update` run for the millionth time when testing new CI > routines. It sort of makes me crazy(er). > > * A version/branch parameter would be useful for the Jenkins pipelines > for generating docs artifacts from different branches. > > * Publishing scripts seem to need a security refactor, or we don't > bother offering stand-alone access to them; running local versus on > Jenkins. > > * I don't see any documentation on the S3 publishing steps and how to test > this. > > * After breaking out each docs package in its own pipeline, I see > opportunities to use the GitHub API to check the PR payload and be > selective about what tests to run. > > > On Wed, Aug 14, 2019 at 10:03 PM Zhao, Patric > wrote: > > > > Hi Aaron, > > > > Recently, we are working on improving the documents of CPU backend based > on the current website. > > > > I saw there're several PRs to update the new website and it's really > great. > > > > Thus, I'd like to know when the new website will online. > > If it's very near, we will switch our works to the new website. > > > > Thanks, > > > > --Patric > > > > > > > -Original Message- > > > From: Aaron Markham > > > Sent: Thursday, August 15, 2019 11:40 AM > > > To: dev@mxnet.incubator.apache.org > > > Subject: Re: CI and PRs > > > > > > The PRs Thomas and I are working on for the new docs and website share > > > the mxnet binary in the new CI pipelines we made. Speeds things up a > lot. > > > > > > On Wed, Aug 14, 2019, 18:16 Chris Olivier > wrote: > > > > > > > I see it done daily now, and while I can’t share all the details, > it’s > > > > not an incredibly complex thing, and involves not much more than > > > > nfs/efs sharing and remote ssh commands. All it takes is a little > > > > ingenuity and some imagination. > > > > > > > > On Wed, Aug 14, 2019 at 4:31 PM Pedro Larroy > > > > > > > > > > > > wrote: > > > > &
Re: new website (RE: CI and PRs)
I'll start a different thread about the website. Sure, there's a lot of overlap with CI. I learned a lot in the last few weeks having to iterate on 7 different docs packages and trying to streamline the build process in CI. Here are my notes: * Stash operations vs. archiving - recommendations in the docs suggest that large artifacts should be archived; stash is super slow; archived artifacts seems to be faster and can be used between pipelines. This is helpful for the MXNet binary and for the Scala package, both of which are used by various other docs packages. However, there's an implication with the master server. Archived artifacts are stored there, so if the pipeline is related to PR validation, this would be unwieldy. If related to publishing final artifacts for specific versions, well, that's probably ok. * It seems that efficiency in development and testing can be gained by checkpointing the docker containers after the dependencies are installed. I can't stress how much time is lost while watching `apt-get update` run for the millionth time when testing new CI routines. It sort of makes me crazy(er). * A version/branch parameter would be useful for the Jenkins pipelines for generating docs artifacts from different branches. * Publishing scripts seem to need a security refactor, or we don't bother offering stand-alone access to them; running local versus on Jenkins. * I don't see any documentation on the S3 publishing steps and how to test this. * After breaking out each docs package in its own pipeline, I see opportunities to use the GitHub API to check the PR payload and be selective about what tests to run. On Wed, Aug 14, 2019 at 10:03 PM Zhao, Patric wrote: > > Hi Aaron, > > Recently, we are working on improving the documents of CPU backend based on > the current website. > > I saw there're several PRs to update the new website and it's really great. > > Thus, I'd like to know when the new website will online. > If it's very near, we will switch our works to the new website. > > Thanks, > > --Patric > > > > -Original Message- > > From: Aaron Markham > > Sent: Thursday, August 15, 2019 11:40 AM > > To: dev@mxnet.incubator.apache.org > > Subject: Re: CI and PRs > > > > The PRs Thomas and I are working on for the new docs and website share > > the mxnet binary in the new CI pipelines we made. Speeds things up a lot. > > > > On Wed, Aug 14, 2019, 18:16 Chris Olivier wrote: > > > > > I see it done daily now, and while I can’t share all the details, it’s > > > not an incredibly complex thing, and involves not much more than > > > nfs/efs sharing and remote ssh commands. All it takes is a little > > > ingenuity and some imagination. > > > > > > On Wed, Aug 14, 2019 at 4:31 PM Pedro Larroy > > > > > > > > > wrote: > > > > > > > Sounds good in theory. I think there are complex details with > > > > regards of resource sharing during parallel execution. Still I think > > > > both ways can > > > be > > > > explored. I think some tests run for unreasonably long times for > > > > what > > > they > > > > are doing. We already scale parts of the pipeline horizontally > > > > across workers. > > > > > > > > > > > > On Wed, Aug 14, 2019 at 5:12 PM Chris Olivier > > > > > > > > wrote: > > > > > > > > > +1 > > > > > > > > > > Rather than remove tests (which doesn’t scale as a solution), why > > > > > not > > > > scale > > > > > them horizontally so that they finish more quickly? Across > > > > > processes or even on a pool of machines that aren’t necessarily the > > build machine? > > > > > > > > > > On Wed, Aug 14, 2019 at 12:03 PM Marco de Abreu < > > > marco.g.ab...@gmail.com > > > > > > > > > > wrote: > > > > > > > > > > > With regards to time I rather prefer us spending a bit more time > > > > > > on maintenance than somebody running into an error that could've > > > > > > been > > > > caught > > > > > > with a test. > > > > > > > > > > > > I mean, our Publishing pipeline for Scala GPU has been broken > > > > > > for > > > quite > > > > > > some time now, but nobody noticed that. Basically my stance on > > > > > > that > > > > > matter > > > > > > is that as soon as something is not b
new website (RE: CI and PRs)
Hi Aaron, Recently, we are working on improving the documents of CPU backend based on the current website. I saw there're several PRs to update the new website and it's really great. Thus, I'd like to know when the new website will online. If it's very near, we will switch our works to the new website. Thanks, --Patric > -Original Message- > From: Aaron Markham > Sent: Thursday, August 15, 2019 11:40 AM > To: dev@mxnet.incubator.apache.org > Subject: Re: CI and PRs > > The PRs Thomas and I are working on for the new docs and website share > the mxnet binary in the new CI pipelines we made. Speeds things up a lot. > > On Wed, Aug 14, 2019, 18:16 Chris Olivier wrote: > > > I see it done daily now, and while I can’t share all the details, it’s > > not an incredibly complex thing, and involves not much more than > > nfs/efs sharing and remote ssh commands. All it takes is a little > > ingenuity and some imagination. > > > > On Wed, Aug 14, 2019 at 4:31 PM Pedro Larroy > > > > > > wrote: > > > > > Sounds good in theory. I think there are complex details with > > > regards of resource sharing during parallel execution. Still I think > > > both ways can > > be > > > explored. I think some tests run for unreasonably long times for > > > what > > they > > > are doing. We already scale parts of the pipeline horizontally > > > across workers. > > > > > > > > > On Wed, Aug 14, 2019 at 5:12 PM Chris Olivier > > > > > > wrote: > > > > > > > +1 > > > > > > > > Rather than remove tests (which doesn’t scale as a solution), why > > > > not > > > scale > > > > them horizontally so that they finish more quickly? Across > > > > processes or even on a pool of machines that aren’t necessarily the > build machine? > > > > > > > > On Wed, Aug 14, 2019 at 12:03 PM Marco de Abreu < > > marco.g.ab...@gmail.com > > > > > > > > wrote: > > > > > > > > > With regards to time I rather prefer us spending a bit more time > > > > > on maintenance than somebody running into an error that could've > > > > > been > > > caught > > > > > with a test. > > > > > > > > > > I mean, our Publishing pipeline for Scala GPU has been broken > > > > > for > > quite > > > > > some time now, but nobody noticed that. Basically my stance on > > > > > that > > > > matter > > > > > is that as soon as something is not blocking, you can also just > > > > deactivate > > > > > it since you don't have a forcing function in an open source project. > > > > > People will rarely come back and fix the errors of some nightly > > > > > test > > > that > > > > > they introduced. > > > > > > > > > > -Marco > > > > > > > > > > Carin Meier schrieb am Mi., 14. Aug. > > > > > 2019, > > > 21:59: > > > > > > > > > > > If a language binding test is failing for a not important > > > > > > reason, > > > then > > > > it > > > > > > is too brittle and needs to be fixed (we have fixed some of > > > > > > these > > > with > > > > > the > > > > > > Clojure package [1]). > > > > > > But in general, if we thinking of the MXNet project as one > > > > > > project > > > that > > > > > is > > > > > > across all the language bindings, then we want to know if some > > > > > fundamental > > > > > > code change is going to break a downstream package. > > > > > > I can't speak for all the high level package binding > > > > > > maintainers, > > but > > > > I'm > > > > > > always happy to pitch in to provide code fixes to help the > > > > > > base PR > > > get > > > > > > green. > > > > > > > > > > > > The time costs to maintain such a large CI project obviously > > > > > > needs > > to > > > > be > > > > > > considered as well. > > > > > > > > > > > > [1] https://github.com/apache/incubator-mxnet/pull/15579 > > > > > > > > > &
