Page Comparison

...

• In edx/edx-documentation:

  • On the master branch:

    • Make release-specific pages for installation and release notes:

      • For example:

        • edx-documentation/en_us/install_operations/source/platform_releases/juniper.rst (remember to include this new page in the TOC)

        • edx-documentation/en_us/open_edx_release_notes/source/juniper.rst (see PR, remember to include this new page in the TOC)

      • This is how it was done for Juniper: https://github.com/edx/edx-documentation/pull/1868

      • Make sure these pages are also on the open-release/zebrawood.master branch (cherry-pick if it needed).

  • On the open-release/zebrawood.master branch:

    • Update the titles of three books. The titles should be changed from “<Versionless Title>“ to “<Versionless Title>: <Version> Release“.

    • Also change intro paragraphs that explain what the book applies to.

    • For example, https://github.com/edx/edx-documentation/pull/1867

    • In each book, update source/index.rst and source/conf.py

      • "Building and Running an Open edX Course"

        • edx-documentation/en_us/open_edx_course_authors

      • "Installing, Configuring, and Running the Open edX Platform"

        • edx-documentation/en_us/install_operations

      • "Open edX Learner's Guide"

        • edx-documentation/en_us/open_edx_students

    • In shared/conf.py, update the “release_line” variable to have the name of the release:

      Code Block
      release_line = "zebrawood"

• On readthedocs.org, logged in as “edx”:

  • Find the three Open edX book projects:

    • “Open edX Building and Running a Course”
      https://readthedocs.org/projects/open-edx-building-and-running-a-course/

    • ”edX Installing, Configuring, and Running”
      https://readthedocs.org/projects/edx-installing-configuring-and-running/

    • ”Open edX Learner's Guide”
      https://readthedocs.org/projects/open-edx-learner-guide/

  • For each, find the new release version in the Versions tab, and make it Active. Keep it Hidden until the release is official.

    • If the new release isn’t in the version list:

      • Check that the webhook is properly configured in GitHub edx/edx-documentation.

      • Then create any branch in the repo to force readthedocs to synchronize the branches as versions.

• In edx/edx-developer-docs:

  • Update named_releases.rst with a new section for the new release.

    • For example: https://github.com/edx/edx-developer-docs/pull/30

    • (on what branch? master, then cherry-pick? -Kyle)

...

This will change .po and .mo files that will need to be committed.

4. Run through the native installation (until Lilac)

No matter what CI says, and even if you have reports of the same exact git hash having been successfully tested the day before, test-install the branch before tagging it. At the time of writing, this means going through all the steps defined in Koa Native Open edX platform Ubuntu 20.04 64 bit Installation . This will avoid anything from last-minute requirements installation problems, to full-blown Ubuntu package removals.

...