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 el2g guide #733

Merged
merged 1 commit into from
Aug 5, 2024
Merged

Conversation

kprosise
Copy link
Contributor

@kprosise kprosise commented Aug 1, 2024

Minor rST syntax issues were causing some formatting mistakes. Additional style and grammar cleanups also done.

QA Steps: Ran linter. Viewed output in browser.

No related tasks, minor 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

Cleaned up a couple minor issues, added some links to the glossary

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.

Minor rST syntax issues were causing some formatting mistakes.
Additional style and grammar cleanups also done.

QA Steps: Ran linter. Viewed output in browser.

No related tasks, minor fix.

Signed-off-by: Katrina Prosise <[email protected]>
@kprosise kprosise requested review from vanmaegima and a team August 1, 2024 11:51
@doanac
Copy link
Member

doanac commented Aug 1, 2024

@kprosise kprosise merged commit f1b2669 into foundriesio:main Aug 5, 2024
1 of 3 checks passed
@kprosise kprosise deleted the cleanup-el2g-guide branch August 5, 2024 10:06
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