Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Add the new installation version on the get_start page: Set the new version to be default, and add the dropdown option. See this example
  2. Add download links to the install archives. See this example. Make sure to use archive.apache.org for all except the current one.
  3. Update the pip package table in /python/cpu/pip.md and /python/gpu/pip.md. See this example
    • This has a sketch file that can be updated to generate a new png image. Because this file is live and pulled from the web-data repo, you need to submit a PR to this repo with the new image. It is recommended that you add a new one with the version name. Then in your PR for the html updates, you refer to this specific new image, rather than updating the one that is used in production.
  4. Update and generate the image file for pip install table.
  5. Add menu options for general version dropdown. Add the new release version number in _config.ym, _config_beta.tml and _config_prod.yml under '- master'.
  6. Prepare and deploy the release version website artifacts, at the time this step requires certain access permissions to dev Jenkins server, MXNet S3 and codeCommit. Please reach out to MXNet Engineering team for more information.

...

  1. Cherry-pick above changes (step 1-4 5 in 3.2.1) from release branch to master branch.
  2. Set default website version to new release version by updating the RewriteRule in /docs/static_site/src/.htaccess under comment "# Set default website version to current stable". For example: update the version 1.x to the new release version: 
    • RewriteRule ^(.*)$ /versions/1.x/$1 [r=307,L] => RewriteRule ^(.*)$ /versions/{NEW RELEASE VERSION}/$1 [r=307,L]
  3. Contact the website maintainer (Yang Shi) to check if the update are all good.
    • The docs will be published to http://mxnet.incubator.apache.org/. There can be a delay due to some edge caching with Apache infra. The restricted-website-build job also runs four times a day.

...