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

feat: Add Device Service System Events docs and update SDK APIs #1372

Merged
merged 1 commit into from
Sep 9, 2024

Conversation

jinlinGuan
Copy link
Contributor

also fix some broken links

If your build fails due to your commit message not passing the build checks, please review the guidelines here: https://github.com/edgexfoundry/edgex-docs/blob/main/.github/Contributing.md

PR Checklist

Please check if your PR fulfills the following requirements:

  • Changes have been rendered and validated locally using mkdocs-material (see edgex-docs README)

@@ -4,7 +4,7 @@ title: Device Service SDK - Purpose

# Device Service SDK - Purpose

The EdgeX device service [software development kits](../../../general/Definitions.md#software-development-kit) (SDKs) help developers create new [device](../../../general/Definitions.md#Device) connectors for EdgeX. An SDK provides the common scaffolding that each device service needs. This allows developers to create new device/sensor connectors more quickly.
The EdgeX device service [software development kits](../../../general/Definitions.md#software-development-kit) (SDKs) help developers create new [device](../../../general/Definitions.md#device) connectors for EdgeX. An SDK provides the common scaffolding that each device service needs. This allows developers to create new device/sensor connectors more quickly.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The EdgeX device service [software development kits](../../../general/Definitions.md#software-development-kit) (SDKs) help developers create new [device](../../../general/Definitions.md#device) connectors for EdgeX. An SDK provides the common scaffolding that each device service needs. This allows developers to create new device/sensor connectors more quickly.
The EdgeX device service [software development kits](../../../general/Definitions.md#software-development-kit) (SDKs) help developers create new [device](../../../general/Definitions.md#device) connectors for EdgeX. An SDK provides the common scaffolding that each device service needs. This allows developers to create new device/sensor connectors more quickly.

@jumpingliu
Copy link
Contributor

jumpingliu commented Sep 5, 2024

Hi Ginny, the above comments is just minor and can be addressed after Cloud's review, thanks.

jumpingliu
jumpingliu previously approved these changes Sep 6, 2024
Copy link
Contributor

@jumpingliu jumpingliu left a comment

Choose a reason for hiding this comment

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

LGTM

also fix some broken links

Signed-off-by: Ginny Guan <ginny@iotechsys.com>
Copy link
Member

@cloudxxx8 cloudxxx8 left a comment

Choose a reason for hiding this comment

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

LGTM

@cloudxxx8 cloudxxx8 merged commit 35c9e06 into edgexfoundry:main Sep 9, 2024
2 of 3 checks passed
edgex-jenkins added a commit that referenced this pull request Sep 9, 2024
Signed-off-by: edgex-jenkins <collab-it+edgex@linuxfoundation.org>
@jinlinGuan jinlinGuan deleted the sdk-issue-1611 branch September 9, 2024 09:45
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.

3 participants