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

docs: remove the child device configuration management page #2593

Merged

Conversation

reubenmiller
Copy link
Contributor

Proposed changes

Remove the page guiding the user how to write an agent to handle the configuration operations using python. The goals of the page are no longer aligned with the project as the tedge-agent can be run on child devices, and the page should focus on an overall implementation rather than only the configuration operation handler.

Future proposal:

Write a new page which details how to write a full custom python agent which uses the thin-edge.io interface, and to include full testing of the solution. Such an agent, python-tedge-agent, already exists and is used in one of the examples in the tedge-demo-container project.

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

#2551

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

The example is not longer aligned with the current thin-edge.io version and updating will require a complete rewrite to align with the https://github.com/thin-edge/python-tedge-agent repo.

Signed-off-by: Reuben Miller <reuben.d.miller@gmail.com>
Signed-off-by: Reuben Miller <reuben.d.miller@gmail.com>
Copy link
Contributor

Robot Results

✅ Passed ❌ Failed ⏭️ Skipped Total Pass % ⏱️ Duration
380 0 3 380 100 54m31.48s

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

@reubenmiller reubenmiller added this pull request to the merge queue Jan 16, 2024
Merged via the queue into thin-edge:main with commit 2cf1aaf Jan 16, 2024
17 checks passed
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