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

Cleanup and fixes for lmp-testplan page #724

Merged
merged 1 commit into from
Jul 15, 2024

Conversation

kprosise
Copy link
Contributor

Language changed to clarify. reference to private repo removed. Link to release notes folder added, and release notes for v92 and v93 updated to include links to test results.
Other minor fixes to style applied.

QA Steps: ran link check, checked links manually, and viewed rendered html. Also ran linter. No issues to report.

No related task, quick fix.

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

Addresses feedback reported internally via Slack

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.

Language changed to clarify. reference to private repo removed.
Link to release notes folder added, and release notes for v92 and v93
updated to include links to test results.
Other minor fixes to style applied.

QA Steps: ran link check, checked links manually, and
viewed rendered html. Also ran linter. No issues to report.

No related task, quick fix.

Signed-off-by: Katrina Prosise <[email protected]>
@kprosise kprosise requested review from gcgrey, mwasilew, vanmaegima and a team July 15, 2024 13:53
@doanac
Copy link
Member

doanac commented Jul 15, 2024

@kprosise kprosise merged commit 7c8a7e0 into foundriesio:main Jul 15, 2024
2 of 3 checks passed
@kprosise kprosise deleted the cleanup-test-plan-doc branch July 15, 2024 15:02
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.

3 participants