Skip to content

docs: document tedge diag collect user-guide#3663

Merged
rina23q merged 1 commit intothin-edge:mainfrom
rina23q:docs/3646/tedge-diag-user-guide
Jun 16, 2025
Merged

docs: document tedge diag collect user-guide#3663
rina23q merged 1 commit intothin-edge:mainfrom
rina23q:docs/3646/tedge-diag-user-guide

Conversation

@rina23q
Copy link
Copy Markdown
Member

@rina23q rina23q commented Jun 3, 2025

Proposed changes

Document user guide for tedge diag collect

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

#3646

Checklist

  • I have read the CONTRIBUTING doc
  • I have signed the CLA (in all commits with git commit -s. You can activate automatic signing by running just prepare-dev once)
  • I ran just format as mentioned in CODING_GUIDELINES
  • I used just check 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

@codecov
Copy link
Copy Markdown

codecov bot commented Jun 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@reubenmiller reubenmiller added documentation Improvements or additions to documentation theme:troubleshooting Theme: Troubleshooting and remote control labels Jun 4, 2025
@rina23q rina23q had a problem deploying to Test Pull Request June 12, 2025 15:06 — with GitHub Actions Failure
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 with two suggestions.

@rina23q rina23q had a problem deploying to Test Pull Request June 13, 2025 11:50 — with GitHub Actions Failure
Copy link
Copy Markdown
Contributor

@albinsuresh albinsuresh left a comment

Choose a reason for hiding this comment

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

Approved with some minor suggestions.

description: How to collect logs and system diagnostics using plugin-based automation
---

%%te%% helps you collect all diagnostic information about your device and services with a single command running user-defined diagnostic plugins.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
%%te%% helps you collect all diagnostic information about your device and services with a single command running user-defined diagnostic plugins.
%%te%% diagnostic collector helps you collect all diagnostic information about your device and services with a single command which can be further extended with user-defined diagnostic plugins.

As this tool is not just about user-defined plugins but also the inbuilt plugins.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Applied all your suggestions here 81c0644.

Copy link
Copy Markdown
Contributor

@reubenmiller reubenmiller left a comment

Choose a reason for hiding this comment

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

Approved. I pushed some minor tweaks in f9fd1c8, but overall a nice read.

@rina23q rina23q had a problem deploying to Test Pull Request June 16, 2025 10:18 — with GitHub Actions Failure
Signed-off-by: Rina Fujino <rina.fujino.23@gmail.com>
@rina23q rina23q force-pushed the docs/3646/tedge-diag-user-guide branch from 81c0644 to 759d73a Compare June 16, 2025 10:36
@rina23q rina23q temporarily deployed to Test Pull Request June 16, 2025 10:36 — with GitHub Actions Inactive
@rina23q rina23q enabled auto-merge June 16, 2025 10:45
@github-actions
Copy link
Copy Markdown
Contributor

Robot Results

✅ Passed ❌ Failed ⏭️ Skipped Total Pass % ⏱️ Duration
641 0 3 641 100 1h47m42.267299999s

@rina23q rina23q added this pull request to the merge queue Jun 16, 2025
Merged via the queue into thin-edge:main with commit 907b838 Jun 16, 2025
34 checks passed
@rina23q rina23q deleted the docs/3646/tedge-diag-user-guide branch August 8, 2025 11:58
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:troubleshooting Theme: Troubleshooting and remote control

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants