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

Add wireguard dependency note #750

Closed

Conversation

kprosise
Copy link
Contributor

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

Adds a dependency reported by customer.

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.

Changes to intro/product summary blurb made to follow Marketing
messaging guidelines. Link at top no goes to product page of the
foundries.io website.

Note that other requested changes which involve the sidebar,
header, or footer will be handled in a separate PR.

QA: Ran linkcheck and viewed built HTML.

This commit addresses FFTK-3449

Signed-off-by: Katrina Prosise <katrina.prosise@foundries.io>
Added to ``apt`` command to install dependencies.

QA Steps: Checked that the package name is correct, checked rendered
output. Ran linkcheck. No issues found.

This commit addresses FFTK-3454, "Documentation: Wireguard dependency"

Signed-off-by: Katrina Prosise <katrina.prosise@foundries.io>
@kprosise kprosise requested review from vanmaegima, caiotpereira and a team September 11, 2024 10:20
@doanac
Copy link
Member

doanac commented Sep 11, 2024

@kprosise kprosise closed this Sep 11, 2024
@kprosise kprosise deleted the add-wireguard-dependency-note branch September 11, 2024 13:52
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