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 notes to separate folder #718

Merged
merged 1 commit into from
Jun 21, 2024

Conversation

kprosise
Copy link
Contributor

Copied release notes to new folder at repo root, and converted to Markdown.

QA: Viewed partially rendered markdown locally, GitHub flavored Markdown means a full check locally is not possible.

This commit applies to FFTK-3255

PR Template and Checklist

Please complete as much as possible to speed up the reviewing process.

Readiness and adding reviewers as appropriate is required.

All PRs should be reviewed by a technical writer/documentation team and a peer.
If effecting customers—which is a majority of content changes—a member of Customer Success must also review.

Readiness

  • Merge

Overview

This will make it easier to properly test further work on FFTK-3255, which is decoupling the release notes from the documentation. Follow up PR will remove the rst, and replace sidebar release note links to point to the GitHub repo. This will allow for any changes/updates post release to easily be updated.

  • 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.

Comments

Merging immediately, to aid with testing next update

Copied release notes to new folder at repo root, and converted to
Markdown.

QA: Viewed partially rendered markdown locally, GitHub flavored
Markdown means a full check locally is not possible.

This commit applies to FFTK-3255

Signed-off-by: Katrina Prosise <[email protected]>
@kprosise kprosise requested a review from a team June 21, 2024 12:14
@doanac
Copy link
Member

doanac commented Jun 21, 2024

@kprosise kprosise merged commit c22f56c into foundriesio:main Jun 21, 2024
1 of 3 checks passed
@kprosise kprosise deleted the add-seperate-release-notes branch June 21, 2024 12:34
kprosise added a commit to kprosise/docs that referenced this pull request Jun 21, 2024
Replaced release note pages with external links.
These point to Markdown documents on main, allowing release notes to
easily be updated post-release.

This is a follow up to PR foundriesio#718.

QA Steps: Checked rendered output and tested links

This commit addresses FFTK-3256

Signed-off-by: Katrina Prosise <[email protected]>
kprosise added a commit to kprosise/docs that referenced this pull request Jun 21, 2024
Replaced release note pages with external links.
These point to Markdown documents on main, allowing release notes to
easily be updated post-release.

This is a follow up to PR foundriesio#718.

QA Steps: Checked rendered output and tested links

This commit addresses FFTK-3256

Signed-off-by: Katrina Prosise <[email protected]>
kprosise added a commit that referenced this pull request Jun 24, 2024
Replaced release note pages with external links.
These point to Markdown documents on main, allowing release notes to
easily be updated post-release.

This is a follow up to PR #718.

QA Steps: Checked rendered output and tested links

This commit addresses FFTK-3256

Signed-off-by: Katrina Prosise <[email protected]>
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.

2 participants