Merge pull request #10 from ThomasDelteil/new_website_pipeline_2_updates

update readmes for doc; remove unused files

ci/publish/website/README.md

@@ -1,39 +1,3 @@
 # Website Deployment
 
-Automatically generated docs for each API are hosted their own folder with the following structure:
-* /api/$lang - Example: api/python
-* /api/$lang/docs/ - An overview.
-* /api/$lang/docs/api/ - the automatically generated API reference
-* /api/$lang/docs/guide/ - overview on how to use it and links to important information
-* /api/$lang/docs/tutorials/ - overview on the list of tutorials
-
-
-## Generating Artifacts
-
-You can use the CI scripts to generate artifacts for each language. For example, to generate C++ API docs found in `/api/python/docs/api/` you can call the following:
-
-```bash
-ci/build.py --docker-registry mxnetci --platform ubuntu_cpu_python --docker-build-retries 3 --shm-size 500m /work/runtime_functions.sh build_python_docs
-```
-
-This will generate docs for whatever branch you have currently checked out.
-
-Refer to [ci/README.md](https://github.com/apache/incubator-mxnet/blob/master/ci/README.md) for setup instructions for Docker and docker-python. These are required for running the `build.py` script.
-
-CI stores the artifacts by job run and also has a "latest generated artifacts" link that you can use when a particular docs branch is having issues. You can at least build the website with the latest known version.
-
-
-## Publishing Artifacts
-
-The artifacts are being hosted on S3 in MXNet's public folder. For example, the Julia microsite can be found at: https://mxnet-public.s3.us-east-2.amazonaws.com/docs/v1.5.0/julia-artifacts.tgz
-
-You must have write access to this bucket to publish new artifacts. You may request access from a committer. Anyone can read from the bucket.
-
-Preview the `publish_artifacts.sh` script and verify the settings. You may want to change the version number, which will affect the bucket location.
-
-
-## Deploying the Website
-
-The website is deployed automatically several times a day through a Jenkins CI job. This job calls the `deploy.sh` script.
-
-Once the artifacts are available on S3, you can use the `deploy.sh` script to manually deploy the website. This assumes you have the environment variables set for a username and password with write permissions to the `apache/incubator-mxnet-site` repo.
+Refer to the [MXNet Developer Wiki](https://cwiki.apache.org/confluence/display/MXNET/Building+the+New+Website).

ci/publish/website/beta-deploy.sh

@@ -0,0 +1,34 @@
+#!/bin/bash
+
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# A yaml file is written to trigger a staging deployment.
+# This file must be placed in the root of the site repo.
+# profile: sets custom the url using the pattern 'mxnet-PROFILE'
+# Example using 'beta': https://mxnet-beta.staged.apache.org/
+# Documentation: https://www.staged.apache.org/
+
+set -ex
+
+if [ ! -f ./.asf.yaml ]; then
+  echo -e "\nGenerating .asf.yaml file"
+  cat > ./.asf.yaml <<EOL
+staging:
+  profile: beta
+EOL
+fi

docs/README.md

@@ -30,6 +30,8 @@ Each language documentation is built in a modular way, so that if you are a cont
 
 You can also use the project's CI tools to emulate any changes with Docker. You can use these tools to install dependencies and run the parts of the build you want to test.
 
+Refer to the [MXNet Developer Wiki](https://cwiki.apache.org/confluence/display/MXNET/Building+the+New+Website) for instructions on building the docs locally.
+
 If you plan to contribute changes to the documentation or website, please submit a pull request. Contributions are welcome!
 
 ## Python Docs
@@ -176,4 +178,4 @@ This information is maintained on the [MXNet Wiki](https://cwiki.apache.org/conf
 - If C++ code has been changed, remove the previous results to trigger the rebuild for all pages. To do this, run `make clean_docs`.
 - If C++ code fails to build, run `make clean`.
 - If CSS or javascript are changed, clear the cache in the browser with a *forced refresh*.
-- If search doesn't work, run `make clean` and then `make docs`.
+- If search doesn't work, run `make clean` and then `make docs`.