Skip to content

docs: add notes to firmware on-boarding instructions#3181

Merged
reubenmiller merged 2 commits intothin-edge:mainfrom
reubenmiller:docs-add-suffix
Oct 10, 2024
Merged

docs: add notes to firmware on-boarding instructions#3181
reubenmiller merged 2 commits intothin-edge:mainfrom
reubenmiller:docs-add-suffix

Conversation

@reubenmiller
Copy link
Copy Markdown
Contributor

Proposed changes

Add a note about the on-boarding instructions under the firmware section for tips on using the c8y-tedge go-c8y-cli extension.

Also update the c8y tedge scan command output example to reflect the current state of the c8y-tedge output (where the mdns suffix was added to each of the detected devices)

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
  • Documentation Update (if none of the other choices apply)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Paste Link to the issue


Checklist

  • I have read the CONTRIBUTING doc
  • I have signed the CLA (in all commits with git commit -s)
  • I ran cargo fmt as mentioned in CODING_GUIDELINES
  • I used cargo clippy as mentioned in CODING_GUIDELINES
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

Signed-off-by: Reuben Miller <reuben.d.miller@gmail.com>
Signed-off-by: Reuben Miller <reuben.d.miller@gmail.com>
@reubenmiller reubenmiller added documentation Improvements or additions to documentation theme:firmware Theme: Firmware update topics labels Oct 10, 2024
@github-actions
Copy link
Copy Markdown
Contributor

Robot Results

✅ Passed ❌ Failed ⏭️ Skipped Total Pass % ⏱️ Duration
508 0 2 508 100 1h29m34.052562999s

Copy link
Copy Markdown
Contributor

@didier-wenzek didier-wenzek left a comment

Choose a reason for hiding this comment

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

Approved

@reubenmiller reubenmiller added this pull request to the merge queue Oct 10, 2024
Merged via the queue into thin-edge:main with commit 01c26b8 Oct 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation theme:firmware Theme: Firmware update topics

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants