Thanks Marco. Any tutorial that is executable should have the minimum version indicated in its prerequisites section. Even so, we're not testing tutorials against previous versions so while the info would be stated we'd only really be testing against master, AFAIK. I'm inclined to creates guides on how to generate legacy documentation for each API, and remove the complexity of versions from the CI pipeline. One-off generated API docs of old versions could be hosted, but not part of the publishing and CI pipeline. This would be more like PyTorch. https://pytorch.org/docs/versions.html We have to do a bit better than that since we have so many language bindings with varying degrees of support across versions. And we should make sure that search works across versions and is clearly labelled, so you know what you're looking at.
On Mon, Feb 4, 2019 at 4:30 PM Marco de Abreu <marco.g.ab...@gmail.com> wrote: > > Great design! > > The different versioning is a good point, thanks for bringing it up. Could > you elaborate on how we will handle the situation of different versions of > mxnet in future (e.g. examples that require a minimum version)? I assume we > will revamp the website build process as part of these efforts, right? > > Best regards > Marco > > Am Di., 5. Feb. 2019, 01:22 hat Aaron Markham <aaron.s.mark...@gmail.com> > geschrieben: > > > Hello MXNet folks! > > > > As I mentioned last week, I'm soliciting feedback on a website > > redesign. Some of you may have seen the beta site that Mu has been > > working on, which is a big step in the right direction for the > > automatically generated API docs. I've posted a wiki article [1] that > > proposes how to flesh out the new site with an information > > architecture, user flows, and wireframes useful for a design > > treatment. I look forward to your feedback - if not here or on the > > wiki, let's get a discussion going in Slack. Just ping me there. > > > > As a side note and follow up to fixing the redirects on the website, I > > needed to add an artifacts flag in the doc's settings.ini file [2]. > > This setting is triggered in mxdoc.py and lets you take files needed > > for the docs build from master (or your branch) and apply them to old > > version branches that you're building for the website. This also > > transitions some of logic from the post-processing versions update > > step during web publishing. > > > > [1] Website redesign information architecture and wireframe: > > https://cwiki.apache.org/confluence/x/vAMlBg > > [2] Website publish updates: > > https://github.com/apache/incubator-mxnet/pull/14015 > > Cheers, > > Aaron > >
