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

Apply cleanup to changes introduced in pr 699 #762

Merged
merged 1 commit into from
Oct 24, 2024

Conversation

kprosise
Copy link
Contributor

Applied fixes to grammar/style.

Ran linkcheck and linter, and viewed rendered HTML in browser.

No related ticket, 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)

Overview

Applied changes suggested by @mike-scott, as well as a few other grammar/style changes.
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.

Comments

@kprosise kprosise requested review from vkhoroz, mike-scott, vanmaegima and a team October 18, 2024 14:19
@doanac
Copy link
Member

doanac commented Oct 18, 2024

Copy link
Member

@vkhoroz vkhoroz left a comment

Choose a reason for hiding this comment

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

Thanks @kprosise!

LGTM

source/reference-manual/security/device-gateway.rst Outdated Show resolved Hide resolved
source/reference-manual/security/device-gateway.rst Outdated Show resolved Hide resolved
@kprosise kprosise force-pushed the apply-pr-699-cleanup branch from 8461038 to 346428d Compare October 23, 2024 11:52
@doanac
Copy link
Member

doanac commented Oct 23, 2024

@doanac
Copy link
Member

doanac commented Oct 23, 2024

Applied fixes to grammar/style.

Ran linkcheck and linter, and viewed rendered HTML in browser.

No related ticket, quick fix

Signed-off-by: Katrina Prosise <katrina.prosise@foundries.io>
@kprosise kprosise force-pushed the apply-pr-699-cleanup branch from 346428d to c5b2c08 Compare October 24, 2024 08:08
@doanac
Copy link
Member

doanac commented Oct 24, 2024

@kprosise kprosise merged commit c860757 into foundriesio:main Oct 24, 2024
2 of 3 checks passed
@kprosise kprosise deleted the apply-pr-699-cleanup branch October 24, 2024 11:36
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