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 user guide sections d-f #585

Merged
merged 1 commit into from
Aug 24, 2023

Conversation

kprosise
Copy link
Contributor

@kprosise kprosise commented Aug 15, 2023

Three pages were cleaned up to meet style guidelines, and updated where needed.

This included removing dead internal references/links and simplifying wording. Semantic newlines were added.
Note that not all information was verified for being up to date, as the focus was primarily on style.

The issues stated in FFTK 2174 have been addressed except for item 3, which is out of our control.

QA Steps: vale linter, linkcheck, viewed rendered HTML.

This commit addresses FFTK 2527
This commit addresses FFTK 2174
This commit applies to FFTK 988

Readiness

  • Merge (pending reviews)
  • Merge after date or event
  • Draft

Overview

Why merge this PR? What does it solve?

Checklist

Optional. Add a 'x' to steps taken.
You can fill this out after opening the PR. "Did I..."

  • 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.

@doanac
Copy link
Member

doanac commented Aug 15, 2023

@kprosise kprosise requested a review from angolini August 15, 2023 17:21
source/user-guide/el2g.rst Outdated Show resolved Hide resolved
source/user-guide/el2g.rst Outdated Show resolved Hide resolved
source/user-guide/fioctl/index.rst Outdated Show resolved Hide resolved
source/user-guide/fioctl/index.rst Outdated Show resolved Hide resolved
@doanac
Copy link
Member

doanac commented Aug 24, 2023

Three pages were cleaned up to meet style guidelines, and updated where
needed.

This included removing dead internal references/links and simplifying wording.
Semantic newlines were added.
Note that not all information was verified for being up to date, as the
focus was primarily on style.

The issues stated in FFTK 2174 have been addressed except for item 3,
which is out of our control.

QA Steps: vale linter, linkcheck, viewed rendered HTML.

This commit addresses FFTK 2527
This commit addresses FFTK 2174
This commit applies to FFTK 988

Signed-off-by: Katrina Prosise <katrina.prosise@foundries.io>
@doanac
Copy link
Member

doanac commented Aug 24, 2023

@kprosise kprosise merged commit 158481a into foundriesio:main Aug 24, 2023
1 check failed
@kprosise kprosise deleted the cleanup-userguides-d-f branch August 24, 2023 11:22
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