Skip to content
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

Updates navigation titles for release notes #4526

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

KOTungseth
Copy link
Contributor

@KOTungseth KOTungseth commented Mar 20, 2025

Updates the navigation titles for Known issues and Breaking changes pages in the release notes.

Checklist

  • Implement code
  • Add tests
  • Update TypeScript typings
  • Update documentation
  • Add release notes to docs/release-notes/index.md
  • Commit message follows commit guidelines

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the navigation titles for the Known issues and Breaking changes pages in the release notes to better reflect the content of each page.

  • Updates the navigation title in docs/release-notes/known-issues.md to "Known issues".
  • Updates the navigation title in docs/release-notes/breaking-changes.md to "Breaking changes".

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
docs/release-notes/known-issues.md Changed navigation title to "Known issues" for clarity
docs/release-notes/breaking-changes.md Changed navigation title to "Breaking changes" for clarity
@KOTungseth KOTungseth added the Team:Docs Label for the Observability docs team label Mar 20, 2025
Copy link
Member

@trentm trentm left a comment

Choose a reason for hiding this comment

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

Looks good:

Screenshot 2025-03-20 at 1 11 48 PM

Do we intend to also change the navigation_title for the release-notes/index.md page to read "Release Notes" or similar?

Copy link
Contributor

@colleenmcginnis colleenmcginnis left a comment

Choose a reason for hiding this comment

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

@KOTungseth
Copy link
Contributor Author

@trentm to save real estate in the left nav, we're display only the product names for the top level release notes pages.

When you view the top level release notes pages, the titles include release notes.

Here is an idea of what everything will look like when organized in the Release notes section:

Screenshot 2025-03-21 at 11 12 37 AM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:Docs Label for the Observability docs team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants