Internal Notes for Reviewers

sc-8017

Aliases added to older moved releases

What the header says — 2023 & 2024 releases have aliases now so that their old URLs resolve to the new ones where they got moved after the old year-end cleanup process.

Test the redirects

• On any preview of the site, pick a release date file and remove the yearly directory from the URL. You should see the link resolve to the new page.
  • e.g /releases/2024-dec-24/release-notes.html > /releases/2024/2024-dec-24/release-notes.html

Quality of life improvements for release notes process

Generate release notes

• This now creates the release note under a yearly folder to begin with so we don't have to create/move/resolve broken links at the end of each year with create_release_folder() 🎉
• update_quarto_yaml() (inserting the new releases page into the sidebar) and update_index_qmd() (adding the latest release to the index and removing the oldest one from the listing) now also use the new filepath with the format {year}/{year}-mon-00/release-notes.qmd so those files update correctly without adjustment

Year-end release cleanup

Since generating the release notes now creates the releases automatically in a yearly folder:

• We retrieve the filepath of yearly folder instead of creating it create_year_folder() > retrieve_year_folder()
• Since release pages are already where they are supposed to be, we leave them alone in the file structure; REMOVED: move_yearly_releases()
• Just a quick update to update_quarto_yaml() (adding the new yearly accordion to the sidebar) to accommodate for the releases already being in the yearly folder rather than fixing the filepaths after we move the files
• Since we didn't move any files, there are no filepaths to fix; REMOVED: update_paths(), search_links()

Try it yourself

• First, grab this PR: gh pr checkout 626

Creating the test release notes

Before we can test the year-end release cleanup, we'll need to create two sets of test release notes: 2 from 2025 and 1 from 2026.

1. • Open release-scripts/generate-release-notes.ipynb and run the notebook with any release tag of your choice (I just used https://github.com/validmind/documentation/releases/tag/v2.6.7 for all the testing). Leave the date as default for this run. Your preview should show:
     • The new release on index.qmd under Latest Releases and the oldest one from the listing removed
     • The new release under the "About" section in the Releases sidebar and have the filepath: releases/{year}/{year}-mon-00/release-notes.html
2. • Navigate into the site/ folder: cd site
3. • Run the Make command to generate release notes: make release-notes. You can use the same release tag but PICK A DIFFERENT DATE THAT IS IN 2025 THAT ISN'T THE DEFAULT. This is important because we want two "release notes" in 2025 to work with. Your preview should show:
     • The new release on index.qmd under Latest Releases to the left of the previous one you just added
     • The new release under the "About" section in the Releases sidebar on top of the previous one you just added
4. • Finally, generate one more set of release notes, with either method. Same release tag is fine, but MAKE SURE THE DATE IS IN 2026. Your final preview should show:

Index page	Releases section

Cleaning up the "2025" releases

Cool, now that we have releases to clean up:

• Open release-scripts/year-end-cleanup.ipynb and run the notebook, ENTERING IN 2025 WHEN PROMPTED (DO NOT LEAVE DEFAULT AS THIS WILL PULL 2024). You should see:

Updated _quarto.yml sidebar & comment markers	Updated Releases section