Skip to content

Publish Server release notes in the docs #1048

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 36 commits into from
Apr 29, 2025
Merged

Conversation

johndmulhausen
Copy link
Contributor

@johndmulhausen johndmulhausen commented Jan 30, 2025

  • Pull release notes from https://github.com/wandb/server/releases, light copyedit
  • Repurpose Server Release Process page to a new Release Policies page, add redirect
  • List supported releases in /releases/, list EOL releases in /releases/archived/
  • DOCS-1299 Update language about keeping up to date (added by Matt)
  • Add RSS feed button in the Releases index
  • Verified that the RSS feed is valid according to W3c

To archive a release, you would add parent: archived-releases and copy-paste the unsupported admonition from an existing page. As a followup we could create a release note template that extends the default template and responds to a front-matter variable like archived: true.

HTML Previews

Index: https://release-notes-to-hugo.docodile.pages.dev/ref/release-notes/releases/
Archived index: https://release-notes-to-hugo.docodile.pages.dev/ref/release-notes/archived/
Supported notes: https://release-notes-to-hugo.docodile.pages.dev/ref/release-notes/0.67.0/
Unsupported note: https://release-notes-to-hugo.docodile.pages.dev/ref/release-notes/releases/archived/0.61.0/
Release policies: https://release-notes-to-hugo.docodile.pages.dev/ref/release-notes/release-policies/
RSS feed: https://release-notes-to-hugo.docodile.pages.dev/ref/release-notes/releases/index.xml
Unsupported RSS feed (not advertised): https://release-notes-to-hugo.docodile.pages.dev/ref/release-notes/archived/index.xml

@johndmulhausen johndmulhausen requested a review from a team as a code owner January 30, 2025 20:25
github-actions[bot]

This comment was marked as outdated.

Copy link

cloudflare-workers-and-pages bot commented Jan 30, 2025

Deploying docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 281ebf8
Status: ✅  Deploy successful!
Preview URL: https://c61fde57.docodile.pages.dev
Branch Preview URL: https://release-notes-to-hugo.docodile.pages.dev

View logs

@mdlinville mdlinville force-pushed the release-notes-to-hugo branch from 60a40cd to 301698b Compare April 11, 2025 22:00
    - Move and rename
    - Add redirects
    - Update links
    - Rewrites
@mdlinville
Copy link
Contributor

mdlinville commented Apr 11, 2025

@johndmulhausen PTAL at the last few I just pushed, which:

  • Move archived versions to an archive directory and decorate them with an unsupported admonition.
  • Add the archive index
  • Simplify the frontmatter to avoid the need for slug and draft
  • Remove the dates from the release note URLs
  • Remove the word "Release" from the individual release page titles, because it made the left-hand TOC look really cluttered to me.
  • Repurpose the old Server Release Process page to be a new Release Policy page, copyedit, add redirects
  • Copyedit the release note files to remove emoji from headings, fix heading levels, add alt text to image tags that were imported (left the images remote in wandb/server since there were primiarily in archived notes)

I'm not super happy with how the main Release index's left-hand TOC looks.

  • I tried to figure out how to put a "Supported releases" label at the top of the left-hand nav so that it looks more balanced with the Archived entry, but I was not able to figure this out. To try to help with this, I made the Release Support Policy show up first by setting its weight to -1. WDYT?
  • There's a lot of vertical space between the last supported version and the Archived releases link in the TOC. There may be extra padding when a menu has sub-items.

@mdlinville mdlinville changed the title Pull release notes from wandb/server for publishing Publish Server release notes in the docs Apr 18, 2025
@mdlinville mdlinville force-pushed the release-notes-to-hugo branch from caf22e5 to 916fed5 Compare April 18, 2025 19:43
@mdlinville mdlinville force-pushed the release-notes-to-hugo branch from 916fed5 to 44f42d4 Compare April 18, 2025 21:01
@mdlinville mdlinville force-pushed the release-notes-to-hugo branch from 8d03a00 to 74f60e1 Compare April 25, 2025 18:29
@mdlinville
Copy link
Contributor

@johndmulhausen PTAL, everything is fixed except that I can't seem to move Release Notes to be under Reference. I tried changing main to reference in the front matter, and I tried moving the entire release-notes directory to within ref/, but neither worked. Maybe you can have a look with fresh eyes on Monday.

Copy link
Contributor

@mdlinville mdlinville left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks to be in good shape. The 0.68 notes are in sync with the approved draft. I'll merge this PR tomorrow immediately before I create the release on GitHub.

@mdlinville mdlinville merged commit e5b59e0 into main Apr 29, 2025
7 checks passed
@mdlinville mdlinville deleted the release-notes-to-hugo branch April 29, 2025 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants