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

Add link to rgb3gen2 flashing instructions #757

Merged
merged 1 commit into from
Sep 26, 2024

Conversation

kprosise
Copy link
Contributor

Link added to supported boards page.

Built html, checked that link showed and functioned as intended, No issues found.

This commit addresses FFTK-3472 "RB3G2: link to flashing instructions"

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

Keeping it simple; shows up in TOC for board flashing instructions, links to our external flashing instructions. This will make it easy if the instructions are ever added directly to the docs.

Link added to supported boards page.

Built html, checked that link showed and functioned as intended,
No issues found.

This commit addresses FFTK-3472 "RB3G2: link to flashing instructions"

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

doanac commented Sep 24, 2024

@vanmaegima
Copy link
Member

@kprosise lgtm, is the long term idea to move this into our docs or to keep it in the external git?

@kprosise
Copy link
Contributor Author

@kprosise lgtm, is the long term idea to move this into our docs or to keep it in the external git?

Unsure what the plan is.

@kprosise kprosise merged commit 8d29f3b into foundriesio:main Sep 26, 2024
3 checks passed
@kprosise kprosise deleted the add-link-rb3g2-flashing branch September 30, 2024 08:00
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.

5 participants