Re-enable PR website Preview

apache / mxnet

Lightweight, Portable, Flexible Distributed/Mobile Deep Learning with Dynamic, Mutation-aware Dataflow Dep Scheduler; for Python, R, Julia, Scala, Go, Javascript and more

https://mxnet.apache.org

Apache License 2.0

20.78k stars 6.79k forks source link

Re-enable PR website Preview #18682

Open szha opened 4 years ago

szha commented 4 years ago

Description

It would be great to re-enable the preview capability for the website and API doc in PR for the purpose of quality control. We used to have this feature and it was removed as part of restructuring the website. Specifically, it should support:

Uploading the built preview doc in CI into a static hosting place and making it publicly available.
Adding a link to the preview site as a comment in the PR.

You can see examples of this in action in https://github.com/awslabs/autogluon/pull/548

szha commented 4 years ago

In the autogluon case, we used S3 for the static hosting, and I created the staging bucket for this purpose. The bucket is set to have a lifecycle configuration that automatically deletes files older than 30 days so that the file space doesn't blow up

ys2843 commented 4 years ago

For MXNet website, we need to host the preview on an Apache v2.4 server in order to make all the redirect work the same.

szha commented 4 years ago

@ys2843 can this be applied onto s3, or otherwise can we get rid of the redirection?

szha commented 4 years ago

@ys2843 @sandeep-krishnamurthy please treat this task as high priority. now that we have a stable version as the default on the website, the website fixes are not nearly as urgent as being able to preview the website changes automatically in each PR. thanks.