Skip to content

Apply feedback on tutorials #834

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

Merged
merged 1 commit into from
May 21, 2025

Conversation

kprosise
Copy link
Contributor

Customer feedback and additional cleanup applied to tutorials.

QA: ran vale linter while editing, checked rendered HTML output.

This commit addresses issue FFTK-1460, "fixes based on…conversations"

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)

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

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

@kprosise kprosise requested review from vanmaegima and a team May 20, 2025 12:48
Customer feedback and additional cleanup applied to tutorials.

QA: ran vale linter while editing, checked rendered HTML output.

This commit addresses issue FFTK-1460, "fixes based on…conversations"

Signed-off-by: Katrina Prosise <katrina.prosise@foundries.io>
@kprosise kprosise force-pushed the apply-cleanup-feedback branch from ee169bc to 9ae8a70 Compare May 20, 2025 14:29
@kprosise kprosise merged commit 4ed862c into foundriesio:main May 21, 2025
1 of 3 checks passed
@kprosise kprosise deleted the apply-cleanup-feedback branch May 21, 2025 10:37
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