Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: add instructions for updating website default version for a new release

...

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.

5. Set default website version to this new release version by updating the RewriteRule in /docs/static_site/src/.htaccess under comment "# Set default website version to current stable".

                 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]

6. Test the build.

  • Run make html from the docs folder while on your edit branch and make sure the changes look good. At this point you can submit your PR.
  • While the PR is clearing CI, you can also test the publish job. This job happens every 6 hours, but it is good to make sure it's going to work once your PR gets merged.
  • Run the following from the docs/build_version_doc/ folder, but update it to include the new release's branch and name:
    ./build_all_version.sh "v1.4.x;v1.3.x;v1.2.0;v1.1.0;v1.0.0;v0.12.0;v0.11.0;master" "1.4.0;1.3.1;1.2.1;1.1.0;1.0.0;0.12.1;0.11.0;master"
  • Then run the following to update the html and navigation. Make sure you add the new release version in the first parameter. Also update the last parameter to be the public IP of your staging web server. Publish the output of docs/build_version_doc/VersionedWeb to your staging server. For more details refer to building the production website.
    ./update_all_version.sh "1.4.0;1.3.1;1.2.1;1.1.0;1.0.0;0.12.1;0.11.0;master" master http://34.201.8.176/

67. (This step requires CI access. Ask on Slack for assistance if you don't have access.) Configure the Jenkins website publishing job.

...