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 minor updates and fixes to documentation #778

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

kprosise
Copy link
Contributor

Screenshots updated for getting-started, as well as fixes to content noticed while updating screenshots.

Figure titles added for images in getting-started and account management sections.

QA steps: ran linkcheck, edited with linter extensions, viewed rendered HTML.

This commit addresses task FFTK-3481, "Update Screenshots of UI"

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)

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

Any thing else that a maintainer/reviewer should know.
This could include potential issues, rational for approach, etc.

Screenshots updated for getting-started, as well as fixes to content
noticed while updating screenshots.

Figure titles added for images in getting-started and account management
sections.

QA steps: ran linkcheck, edited with linter extensions, viewed rendered
HTML.

This commit addresses task FFTK-3481, "Update Screenshots of UI"

Signed-off-by: Katrina Prosise <[email protected]>
@kprosise kprosise requested review from vanmaegima and a team December 13, 2024 13:09
@vanmaegima
Copy link
Member

vanmaegima commented Dec 13, 2024

@kprosise It seems like we didn't get the automated build on this PR? I only see the vale run.
As this brings a lot of new images, I would like to review the build html.

Copy link
Member

Choose a reason for hiding this comment

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

This doesn't seem to match the old file.

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