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

Decouple release notes from doc releases #719

Merged
merged 1 commit into from
Jun 24, 2024

Conversation

kprosise
Copy link
Contributor

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

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 (pending reviews)
  • Merge after date or event
  • Draft

Overview

This commit is a quick-fix for decoupling the release notes from the docs, allowing the notes to easily be updated post release. This will likely be replaced with a Sphinx focused solution in the future.

Checklist

  • View HTML in a browser to check rendering.
  • 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.

@doanac
Copy link
Member

doanac commented Jun 21, 2024

source/index.rst Outdated Show resolved Hide resolved
@doanac
Copy link
Member

doanac commented 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 <katrina.prosise@foundries.io>
@doanac
Copy link
Member

doanac commented Jun 21, 2024

@angolini
Copy link
Collaborator

I only want to note that it looks weird to have a link in the HTML that points to the GitHub source code.

For me, it's not a "decouple". And for me, it would be better to work for dot releases instead of adding a hack here.

@kprosise
Copy link
Contributor Author

I only want to note that it looks weird to have a link in the HTML that points to the GitHub source code.

For me, it's not a "decouple". And for me, it would be better to work for dot releases instead of adding a hack here.

This is definitely not a long term solution, changing doc release process to include dot releases is definitely something we should consider. My goal here was to having something implemented in time for v94.

@kprosise kprosise merged commit 3eec60f into foundriesio:main Jun 24, 2024
2 of 3 checks passed
@kprosise kprosise deleted the decouple-release-notes branch June 24, 2024 09:11
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.

4 participants