Skip to content

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

@KOTungseth KOTungseth self-assigned this Mar 20, 2025
Copy link

Copilot AI left a comment

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
trentm
trentm previously approved these changes 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

@trentm
Copy link
Member

trentm commented Mar 24, 2025

to save real estate in the left nav

@KOTungseth IIUC using the product name here is primarily for a section of the grouped docs that just presents the Release Notes for all the products. There the context that these are "Release Notes" is clear, granted.

My issue / use case / question is for when a user is looking at just the docs for a given produce, e.g. the Node.js APM agent:
https://docs-v3-preview.elastic.dev/elastic/apm-agent-nodejs/pull/4526/reference/

How does the user know what TOC item to select to view "release notes", or "what has changed recently", or "changelog"?

@colleenmcginnis
Copy link
Contributor

My issue / use case / question is for when a user is looking at just the docs for a given produce, e.g. the Node.js APM agent: https://docs-v3-preview.elastic.dev/elastic/apm-agent-nodejs/pull/4526/reference/

The layout you linked to will only ever be available in PR previews. In the production docs, users will see our global IA. Here's what the Observability part of the Release notes section looks like right now (before this PR is merged).

image

This screenshot was taken from building the entire docs site locally. We're trying to get all these pieces together so we can get the complete IA on staging (so it's a bit of a 🐔 🥚).

@colleenmcginnis colleenmcginnis dismissed stale reviews from trentm and themself via 4fb5634 March 25, 2025 13:42
@colleenmcginnis colleenmcginnis merged commit f243c35 into elastic:main Mar 28, 2025
6 checks passed
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