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 release note section #617

Merged
merged 1 commit into from
Oct 26, 2023
Merged

Conversation

kprosise
Copy link
Contributor

Sidebar entry added for source/release-notes/release-notes.rst. Template file also added.

This commit will allow review of the format.
After being merged, content will be added prior to v92.

QA Steps: built and checked html, no issues noted.

This commit addresses FFTK-2537

Readiness

  • Merge (pending reviews)
  • Merge after date or event
  • Draft

Overview

Why merge this PR? What does it solve?

Checklist

Optional. Add a 'x' to steps taken.
You can fill this out after opening the PR. "Did I..."

  • Run spelling and grammar check, preferably with linter.
  • Avoid changing any header associated with a link/reference.
  • Step through instructions (or ask someone to do so).
  • Review for wordiness
  • Match tone and style of page/section.
  • Run make linkcheck.
  • View HTML in a browser to check rendering.
  • Use semantic newlines.
  • follow best practices for commits.
    • Descriptive title written in the imperative.
    • Include brief overview of QA steps taken.
    • Mention any related issues numbers.
    • End message with sign off/DCO line (-s, --signoff).
    • Sign commit with your gpg key (-S, --gpg-sign).
    • Squash commits if needed.
  • Request PR review by a technical writer and at least one peer.

Comments

This can be seen as a draft, feel free to make suggestions regarding the layout. Actual content will be added prior to next release, but I figured it would be good to establish the template now.

Sidebar entry added for `source/release-notes/release-notes.rst`.
Template file also added.

This commit will allow review of the format.
After being merged, content will be added prior to v92.

QA Steps: built and checked html, no issues noted.

This commit addresses FFTK-2537

Signed-off-by: Katrina Prosise <katrina.prosise@foundries.io>
Copy link
Member

@ricardosalveti ricardosalveti left a comment

Choose a reason for hiding this comment

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

Nice, LGTM

@doanac
Copy link
Member

doanac commented Oct 25, 2023

@angolini
Copy link
Collaborator

Are we going to duplicate the release note file? or the goal is to have it only here and the be displayed in the other site?

@ricardosalveti
Copy link
Member

Are we going to duplicate the release note file? or the goal is to have it only here and the be displayed in the other site?

Not necessarily duplicate it (just the highlights), the idea is to have another location (available via docs) which covers the high level a bit more, besides the migration/updates issues people should be aware of (e.g. when we deprecate something).

Atm we can't have that information easily on our current release notes page.

@kprosise kprosise merged commit 0220c19 into foundriesio:main Oct 26, 2023
3 checks passed
@kprosise kprosise deleted the add-changelog branch October 26, 2023 09:26
@angolini
Copy link
Collaborator

If we are going to have two "different" Release Notes, they must have different names.

I still think we should remove the other one (https://foundries.io/products/releases/91/) and keep only this one (or, display this one in the other link)

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.

5 participants