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 child device tutorial #1642

Merged
merged 2 commits into from
Jan 17, 2023
Merged

Conversation

hansb001
Copy link
Contributor

@hansb001 hansb001 commented Dec 9, 2022

Signed-off-by: Hans Boef hansboef@gmail.com

Proposed changes

Adding a tutorial for child device config management.

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

@hansb001 hansb001 added documentation Improvements or additions to documentation theme:childdevices Theme: Child device related topics labels Dec 9, 2022
@reubenmiller reubenmiller added this to the 0.9.0 milestone Dec 12, 2022
Copy link
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.

The following doc-wide changes are also required:

  1. Replace references to "child device agent" and "agent" with "child device connector" and "connector"
  2. It's a good markdown doc practice to keep multiple sentences in a paragraph across multiple lines instead of keeping them together. This makes the suggestions easier during reviews.
  3. Add images of the Cumulocity UI in relevant sections.

docs/src/tutorials/child-device-config-mngmnt.md Outdated Show resolved Hide resolved
docs/src/tutorials/child-device-config-mngmnt.md Outdated Show resolved Hide resolved
docs/src/tutorials/child-device-config-mngmnt.md Outdated Show resolved Hide resolved
docs/src/tutorials/child-device-config-mngmnt.md Outdated Show resolved Hide resolved
docs/src/tutorials/child-device-config-mngmnt.md Outdated Show resolved Hide resolved
docs/src/tutorials/child-device-config-mngmnt.md Outdated Show resolved Hide resolved
docs/src/tutorials/child-device-config-mngmnt.md Outdated Show resolved Hide resolved
docs/src/tutorials/child-device-config-mngmnt.md Outdated Show resolved Hide resolved
docs/src/tutorials/child-device-config-mngmnt.md Outdated Show resolved Hide resolved
docs/src/tutorials/child-device-config-mngmnt.md Outdated Show resolved Hide resolved
Copy link
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.

The following things must be taken care of, at a doc level, before the next iteration:

  1. Use the admonish blocks as documented here for both Notes and Examples
  2. When accept commit suggestions, use the batch accept feature of github to avoid commits for each and every line as shown:
    here
  3. Make sure that the markdown document renders properly, especially for numbered list items. There were many such numbering issues in the current version.
  4. Double check the links in the rendered version as some of my suggested headline changes will have an impact on these links as well.

docs/src/tutorials/child-device-config-mngmnt.md Outdated Show resolved Hide resolved
docs/src/tutorials/tutorials.md Show resolved Hide resolved
docs/src/tutorials/child-device-config-management.md Outdated Show resolved Hide resolved
docs/src/tutorials/child-device-config-management.md Outdated Show resolved Hide resolved
docs/src/tutorials/child-device-config-management.md Outdated Show resolved Hide resolved
docs/src/tutorials/child-device-config-management.md Outdated Show resolved Hide resolved
docs/src/tutorials/child-device-config-management.md Outdated Show resolved Hide resolved
docs/src/tutorials/child-device-config-management.md Outdated Show resolved Hide resolved
docs/src/tutorials/child-device-config-management.md Outdated Show resolved Hide resolved
@hansb001 hansb001 force-pushed the Doc/Childtutorial branch 2 times, most recently from b24d7c6 to 424161e Compare December 19, 2022 10:37
Signed-off-by: Hans Boef <hansboef@gmail.com>
@albinsuresh
Copy link
Contributor

@hansb001 Made the following major changes in my last commit:

  1. Fixed the indentation of all examples and images
  2. Changed the admonish blocks used for examples to simple console blocks for better formatting
  3. Re-ordered and updated some content

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

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:childdevices Theme: Child device related topics
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants