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

Prepare docs for re-publishing of v94 #766

Merged
merged 1 commit into from
Oct 31, 2024

Conversation

kprosise
Copy link
Contributor

Admonition added for changes from commits 4e459db and e776a48, to allow for a re-release of docs v94. Post-publishing, this commit should be reverted/changes removed.

Built HTML and viewed in browser, ran linkcheck.

This commit addresses the issue in ticket FFTK-3545, Add temp admonitions for re-release

This commit applies to ticket FFTK-3544, Re-release v94 docs…

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

For re-release of v94

Checklist

  • 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

Any thing else that a maintainer/reviewer should know.
This could include potential issues, rational for approach, etc.

Admonition added for changes from commits 4e459db and e776a48, to allow
for a re-release of docs v94. Post-publishing, this commit should be
reverted/changes removed.

Built HTML and viewed in browser, ran linkcheck.

This commit addresses the issue in ticket FFTK-3545, Add temp admonitions
for re-release

This commit applies to ticket FFTK-3544, Re-release v94 docs…

Signed-off-by: Katrina Prosise <katrina.prosise@foundries.io>
@kprosise kprosise requested review from doanac, vanmaegima, mike-sul and a team October 31, 2024 08:24
@doanac
Copy link
Member

doanac commented Oct 31, 2024

Copy link
Member

@doanac doanac left a comment

Choose a reason for hiding this comment

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

LGTM

@kprosise kprosise merged commit e63cded into foundriesio:main Oct 31, 2024
2 of 3 checks passed
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