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

8.6.0-alpha4 release notes #4063

Merged
merged 17 commits into from
Aug 13, 2024
Merged

8.6.0-alpha4 release notes #4063

merged 17 commits into from
Aug 13, 2024

Conversation

akeller
Copy link
Member

@akeller akeller commented Jul 24, 2024

Description

Based on labeled epics

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@akeller akeller added component:docs Documentation improvements, including new or updated content 8.6.0-alpha4 August 2024 alpha release labels Jul 24, 2024
@akeller akeller self-assigned this Jul 24, 2024
@akeller akeller added the hold This issue is parked, do not merge. label Jul 24, 2024
Copy link
Contributor

👋 🤖 🤔 Hello! Did you make your changes in all the right places?

These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.5/.

  • docs/reference/release-notes/860.md

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

@akeller
Copy link
Member Author

akeller commented Aug 8, 2024

‼️ This needs a link from #4053 before merging! ‼️

@akeller akeller marked this pull request as ready for review August 12, 2024 22:09
@akeller akeller removed the hold This issue is parked, do not merge. label Aug 12, 2024
@akeller akeller requested a review from a team August 12, 2024 22:09
@mesellings mesellings self-requested a review August 13, 2024 09:17
@mesellings mesellings self-assigned this Aug 13, 2024
@mesellings
Copy link
Contributor

@christinaausley @conceptualshark I'll perform an initial review 👍

Copy link
Contributor

@mesellings mesellings left a comment

Choose a reason for hiding this comment

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

@akeller Looks good, just a few edits I made directly to the branch.
@christinaausley @conceptualshark I have performed an initial review and made edit commits directly:

  • Some grammatical edits
  • Readability edits for conciseness and clarity
    I haven't approved as I think this PR is set to auto-merge on approval, so I will hold off on approving until you are happy with your review.

Some non-blocking open questions I had:

  • Do we leave out links to docs from the RN for a reason, e.g. for new connectors it would be good to loink to the new connector doc?
  • How do we decide what the order is for entries - is it by 'importance' as it were?
  • If features are public in Github, is it of any value to include issue #s for users, e.g. as a bracketed (Issue Origin/editorialreview cloudconsole #333) somewhere? Just an idea - if customers are tracking an issue, this helps them tie this together with the RN entries.

@christinaausley christinaausley enabled auto-merge (squash) August 13, 2024 11:27
@christinaausley christinaausley merged commit eedf335 into main Aug 13, 2024
7 checks passed
@christinaausley christinaausley deleted the 860-alpha4-release-notes branch August 13, 2024 11:43
@akeller
Copy link
Member Author

akeller commented Aug 13, 2024

  • Do we leave out links to docs from the RN for a reason, e.g. for new connectors it would be good to loink to the new connector doc?
  • How do we decide what the order is for entries - is it by 'importance' as it were?
  • If features are public in Github, is it of any value to include issue #s for users, e.g. as a bracketed (Issue Origin/editorialreview cloudconsole #333) somewhere? Just an idea - if customers are tracking an issue, this helps them tie this together with the RN entries.

There is a lot of room for improvement with this, so most of my answers will be the same—this is best effort while we work out the internal process and habits of adding release notes to epics! We've iterated and improved over every release notes PR since introducing them in 8.5.

Re: links - I would love to link from each epic into the docs, but we usually have a 🐔 🥚 problem where the docs PRs are still coming in as we are building the release notes. We can also follow up with a subsequent PR on or after release day, particularly for alpha releases.

Re: order - it's typically how I see them in Product Hub. There is an open draft PR for more visual grouping, but not ordering.

Re: public issues and epics - these can be hard to find. Some are on a team task board, some are on the docs repo, and some are a combination of private/public epics. I would like to formalize a process here in the future.

Is this something you'd like to get involved with @mesellings?

@mesellings
Copy link
Contributor

@akeller Happy to help/get involved with/lead (whichever is most suitable) - although release notes can be a pain, they also help to really showcase docs sometimes as a single point in time where everybody reads the same new docs at once - it's a great opportunity, look at what it has done for Slack docs in the past for example.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.6.0-alpha4 August 2024 alpha release component:docs Documentation improvements, including new or updated content
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants