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

Issue #1513 Document how to write child device config management agent #1536

Conversation

albinsuresh
Copy link
Contributor

@albinsuresh albinsuresh commented Oct 27, 2022

Proposed changes

Document how to write child device config management agent

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

Copy link
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.

Clear writing. Might be improved with some more context in the introduction, though.

  • The spell checker report typos.
  • mdbook checker reports markdown issues.
  • The SUMMARY.md must be updated.

docs/src/howto-guides/howto-guides.md Outdated Show resolved Hide resolved
docs/src/howto-guides/child_device_config_managament.md Outdated Show resolved Hide resolved
docs/src/howto-guides/child_device_config_managament.md Outdated Show resolved Hide resolved
docs/src/howto-guides/child_device_config_managament.md Outdated Show resolved Hide resolved
docs/src/howto-guides/child_device_config_managament.md Outdated Show resolved Hide resolved
docs/src/howto-guides/child_device_config_managament.md Outdated Show resolved Hide resolved
docs/src/howto-guides/child_device_config_managament.md Outdated Show resolved Hide resolved
docs/src/howto-guides/child_device_config_managament.md Outdated Show resolved Hide resolved
docs/src/howto-guides/child_device_config_managament.md Outdated Show resolved Hide resolved
@albinsuresh albinsuresh force-pushed the doc/1513/child-device-conifg-management-agent-guide branch from cd0704f to eefc85e Compare October 28, 2022 11:27
@albinsuresh albinsuresh force-pushed the doc/1513/child-device-conifg-management-agent-guide branch from eefc85e to 8acd00a Compare October 28, 2022 12:08
Copy link
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. A really nice documentation, clear and pleasant reading.

@albinsuresh albinsuresh force-pushed the doc/1513/child-device-conifg-management-agent-guide branch from 8acd00a to ed485f7 Compare October 31, 2022 06:16
@albinsuresh albinsuresh merged commit 448ce80 into thin-edge:main Oct 31, 2022
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.

None yet

2 participants