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.

Sign up for GitHub

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

Jump to bottom

Cleanup user-guide pages l-mi #586

Merged
merged 1 commit into from
Aug 24, 2023
Merged

Cleanup user-guide pages l-mi #586

merged 1 commit into from
Aug 24, 2023

Conversation

kprosise
Copy link
Contributor

Cleanup of four pages, focusing on applying style guide and simplifying language where applicable. Semantic newlines also implemented, to assist with cleanup as well.

QA Steps: Vale linter and linkcheck ran. Checked render html.

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

@kprosise
Cleanup user-guide pages l-mi
181c515 
Cleanup of four pages, focusing on applying style guide and simplifying
language where applicable. Semantic newlines also implemented, to assist
with cleanup as well.

QA Steps: Vale linter and linkcheck ran. Checked render html.

This commit applies to FFTK 988

Signed-off-by: Katrina Prosise <katrina.prosise@foundries.io>
@kprosise kprosise requested review from angolini, vanmaegima and a team August 16, 2023 16:18
@doanac
Copy link
Member

doanac commented Aug 16, 2023

Docs for 181c515 are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2321/docs/artifacts/html/index.html

@kprosise kprosise merged commit 874a884 into foundriesio:main Aug 24, 2023
1 check failed
@kprosise kprosise deleted the cleanup-userguides-l-mi branch August 24, 2023 10:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@angolini angolini angolini approved these changes

@vanmaegima vanmaegima Awaiting requested review from vanmaegima

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@kprosise @doanac @angolini