mxnet-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Lin Yuan <apefor...@gmail.com>
Subject Re: Versioned Dropdown for Python API Docs
Date Thu, 09 Apr 2020 21:04:46 GMT
Connor,

Good job! Thanks for your contribution. The versioned website looks neat
and hopefully can reduce a lot of confusion to MXNet users.

Best,

Lin


On Thu, Apr 9, 2020 at 11:03 AM Goggins, Connor <cggoggin@amazon.com.invalid>
wrote:

> Hi all, the new production MXNet website (with general API version
> dropdown) is now live: https://mxnet.apache.org/. Users can now leverage
> the general version dropdown to switch between different versions of the
> website corresponding to various MXNet API releases.
>
> If you happen to find any bugs associated with the dropdown or the website
> content, please create a GitHub issue in the repository<
> https://github.com/apache/incubator-mxnet> with the "Website" tag so the
> bug can be fixed.
>
> All the best,
> Connor
>
> From: "Goggins, Connor" <cggoggin@amazon.com>
> Date: Monday, March 30, 2020 at 12:41 PM
> To: "dev@mxnet.apache.org" <dev@mxnet.apache.org>
> Cc: "Krishnamurthy, Sandeep" <krsandee@amazon.com>, "Markham, Aaron" <
> markhama@amazon.com>
> Subject: Re: Versioned Dropdown for Python API Docs
>
> Hi all, quick status update on the Website 2.0 project: currently, v1.6 of
> the website is not available (only the master is available). This presents
> a serious problem to our users, as v1.6 is the current stable release. To
> solve this issue, we tried generating a static artifact for v1.6 (in
> addition to static artifacts for the other versions), but ran into issues
> with building Julia and R docs for v1.6. We traced these errors to the
> version of Python being used for the v1.6 Jenkins pipeline (Python 2.7),
> and agreed that fixing the issue would require converting the entire
> pipeline to use Python 3. Since this will take a significant amount of time
> and we want to make the v1.6 website available to our users as soon as
> possible, we agreed to document the issue here (
> https://github.com/apache/incubator-mxnet/issues/17910) for future work,
> build the static artifact for v1.6 without the Julia & R docs as a stopgap
> solution, and pull in the Julia & R docs from master (since the user impact
> of this will be minimal).
>
> Are there any concerns from the community in taking this approach? Would
> also love to get thoughts from Julia and R contributors on this proposed
> path forward.
>
> From: "Goggins, Connor" <cggoggin@amazon.com>
> Date: Tuesday, March 24, 2020 at 10:43 AM
> To: "dev@mxnet.apache.org" <dev@mxnet.apache.org>
> Cc: "Krishnamurthy, Sandeep" <krsandee@amazon.com>, "Markham, Aaron" <
> markhama@amazon.com>
> Subject: Re: Versioned Dropdown for Python API Docs
>
> By the way, I am currently developing a build pipeline for v1.6, so that
> specific version is not currently available.
>
> From: "Goggins, Connor" <cggoggin@amazon.com>
> Date: Monday, March 23, 2020 at 8:08 PM
> To: "dev@mxnet.apache.org" <dev@mxnet.apache.org>
> Cc: "Krishnamurthy, Sandeep" <krsandee@amazon.com>, "Markham, Aaron" <
> markhama@amazon.com>
> Subject: Re: Versioned Dropdown for Python API Docs
>
> Update on progress so far:
>
>   *   Fixed broken components of static artifacts for old versions
> (internal/external links, menus, etc.)
>   *   Added missing supplemental content (missing tutorials, docs, etc.)
> to static artifacts for old versions
>   *   Implemented working general version dropdown menu capable of
> switching between old artifacts
>   *   Finished general version dropdown for master website (styling and
> functionality) – successfully tested with Jenkins full website build
> I have deployed the artifact generated by the Jenkins full website build
> here<http://ec2-3-19-223-185.us-east-2.compute.amazonaws.com/> as a
> preview. Please let me know if you have any feedback or if there are any
> changes you would like made in the project’s Github issue<
> https://github.com/apache/incubator-mxnet/issues/17798>.
>
> From: "Goggins, Connor" <cggoggin@amazon.com>
> Date: Monday, March 9, 2020 at 6:22 PM
> To: "dev@mxnet.apache.org" <dev@mxnet.apache.org>
> Cc: "Krishnamurthy, Sandeep" <krsandee@amazon.com>, "Markham, Aaron" <
> markhama@amazon.com>
> Subject: Versioned Dropdown for Python API Docs
>
> With the development of MXNet Website 2.0, I propose a version dropdown
> for the Python API docs to support documentation for past releases and
> reduce confusion regarding the incompatibility of past releases with the
> current docs (which only cover master).
>
> Issues is being tracked here<
> https://github.com/apache/incubator-mxnet/issues/17798>.
>

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message