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

Add comprehensive table to release notes page #3862

Merged
merged 5 commits into from
Jun 14, 2024
Merged

Conversation

akeller
Copy link
Member

@akeller akeller commented May 30, 2024

Description

  • Adds table to release notes page (index page)
  • Lists all supported versions, including scheduled end of maintenance dates

👇 Oops, typo'd the date. But it's fixed in the PR itself.
image

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 the component:docs Documentation improvements, including new or updated content label May 30, 2024
@akeller akeller self-assigned this May 30, 2024
Copy link
Contributor

github-actions bot commented May 30, 2024

👋 🤖 ✅ Looks like the changes were ported across versions, nice job! 🎉

You can read more about the versioning within our docs in our documentation guidelines.

@akeller
Copy link
Member Author

akeller commented May 30, 2024

@ev-codes, this PR wouldn't change the info in the drop down, but would it help address #3749?

I could add more context to why we still support 1.3 to this page as well.

@akeller
Copy link
Member Author

akeller commented May 30, 2024

@MaxTru for 8.2-8.4 I linked to the changelog in camunda-platform, thus I call the link "Camunda Platform." Should I call this "Camunda 8 Core" as well, or would this be misleading because not all core components would be available in the camunda-platform repo?

I kept the "scheduled" terminology in the table, but WDYT? Should I add "Scheduled release notes" to the column header?

@ev-codes
Copy link
Contributor

@akeller yes, this would help address #3749 !

Thank you for considering and addressing the feedback.

I could add more context to why we still support 1.3 to this page as well.

I think providing more context about 1.3 support is a good idea!

@MaxTru
Copy link
Contributor

MaxTru commented Jun 9, 2024

@MaxTru for 8.2-8.4 I linked to the changelog in camunda-platform, thus I call the link "Camunda Platform." Should I call this "Camunda 8 Core" as well, or would this be misleading because not all core components would be available in the camunda-platform repo?

Hi @akeller ,
I think your suggestion makes sense since it is just the reality that we used camunda platform for these releases, which is different to the integrated repo we have now.
Thanks

@akeller akeller requested a review from a team June 13, 2024 19:35
@akeller akeller marked this pull request as ready for review June 13, 2024 19:36
@akeller
Copy link
Member Author

akeller commented Jun 13, 2024

@camunda/tech-writers, during review, please note that not all supported versions were in scope for this so we won't backport beyond the current version at this time.

Also, I added a brief disclaimer for CC 1.3/Optimize 3.7, which I was going to link to camunda/issues#182, but I need to check internally if this is the most up-to-date issue on this topic. Given that this is only part of the PR (and not the focus) I would like to move forward and follow up with another PR if this one is ready to merge.

@akeller akeller merged commit 635675f into main Jun 14, 2024
11 checks passed
@akeller akeller deleted the release-notes-table branch June 14, 2024 12:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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