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

Update general and existing glossary terms #695

Merged
merged 1 commit into from
Mar 12, 2024

Conversation

kprosise
Copy link
Contributor

@kprosise kprosise commented Mar 6, 2024

The glossary was cleaned up a bit, new terms added, as well as links to related topic pages.

Links to glossary terms were added in a few areas, with a focus on the 'getting started' sections.

This is the first of a handful of PR commits meant to update the glossary.

QA Steps: Ran build, examined output. No issues spotted. Linkcheck failed due to unrelated issue which has been identified and will be updated separately.

This commit addresses FFTK-3008

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

Why merge this PR? What does it solve?

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

More PRs to follow. Glossary options within Sphinx are pretty limited, so making it look better would require theme editing.

The glossary was cleaned up a bit, new terms added, as well as links to
related topic pages.

Links to glossary terms were added in a few areas, with a focus on the
'getting started' sections.

This is the first of a handful of PR commits meant to update the glossary.

QA Steps: Ran build, examined output. No issues spotted. Linkcheck
failed due to unrelated issue which has been identified and will be
updated separately.

This commit addresses FFTK-3008

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

doanac commented Mar 6, 2024

@kprosise kprosise merged commit 2e4ff85 into foundriesio:main Mar 12, 2024
2 of 3 checks passed
@kprosise kprosise deleted the add-company-terms-glossary branch March 12, 2024 10:56
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