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

doc: suggestion: Clarify Manufacturing Process for Device Registration #615

Merged

Conversation

camilamacedo86
Copy link
Contributor

@camilamacedo86 camilamacedo86 commented Oct 20, 2023

Improve documentation to help users better understand the purpose and relationship between the factory-registration-ref and the device gateway. (to just try make it a little easier to connect the dots here)

Signed-off-by: Camila Macedo [email protected]

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

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

Copy link
Member

@vanmaegima vanmaegima left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@kprosise kprosise left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@camilamacedo86 camilamacedo86 force-pushed the manufactoring-device-registration branch from 6a79198 to 2e577f7 Compare October 20, 2023 15:51
Copy link
Collaborator

@angolini angolini left a comment

Choose a reason for hiding this comment

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

LGTM

Signed-off-by: Camila Macedo <[email protected]>
Co-authored-by: Katrina Prosise <[email protected]>
Co-authored-by: Vanessa Maegima <[email protected]>
Co-authored-by: Daiane Angolini <[email protected]>
@camilamacedo86 camilamacedo86 force-pushed the manufactoring-device-registration branch from 3003855 to e4f198c Compare October 23, 2023 09:26
@kprosise kprosise merged commit b26edc1 into foundriesio:main Oct 23, 2023
1 check passed
@camilamacedo86 camilamacedo86 deleted the manufactoring-device-registration branch October 24, 2023 13:33
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.

4 participants