Add missing device service documentation #598
Labels
2-medium
priority denoting issues with cross-cutting project impact
documentation
enhancement
New feature or request
jakarta
Comments
jpwhitemn
added
2-medium
1 task
|
Per planning meeting of 5/18/22 - complete this for Levski release |
|
Current status is that the following is required to close this issue:
The combination of the first two entries should also close edgexfoundry/device-sdk-go#1001 |
|
"Provisioning at startup" - would that be (start as) static configuration? Can provisioning be provided via configuration.toml? |
|
Noted in WG meeting item 4 is covered by general/ServiceConfiguration.md (and microservices/configuration/ConfigurationAndRegistry.md which is linked from there) |
|
Added #864 for item 3 |
iain-anderson
added a commit
to iain-anderson/edgex-docs
that referenced
this issue
Sep 22, 2022
Signed-off-by: Iain Anderson <[email protected]>
|
#865 for item 1 |
iain-anderson
added a commit
that referenced
this issue
Sep 22, 2022
Signed-off-by: Iain Anderson <[email protected]>
Repository owner
moved this from Todo
to Done
in Levski Documentation Updates
Sep 22, 2022
edgex-jenkins
added a commit
that referenced
this issue
Sep 22, 2022
Signed-off-by: edgex-jenkins <[email protected]>
TomBrennan-Eaton
pushed a commit
to TomBrennan-Eaton/edgex-docs
that referenced
this issue
Sep 26, 2022
…oundry#865) Signed-off-by: Iain Anderson <[email protected]>
TomBrennan-Eaton
added a commit
to TomBrennan-Eaton/edgex-docs
that referenced
this issue
Sep 27, 2022
Noted that, for local builds, now also must have pip install
mkdocs-macros-plugin>=0.5
mkdocs now reports that Line 267 of some unamed .md file has:
INFO - [macros] - ERROR # _Macro Syntax Error_
_Line 267 in Markdown file:_ **expected token ':', got '}'**
Signed-off-by: Tom Brennan <[email protected]>
Update based on review comments.
In particular, added example and requirements to extend Provisioning
for south-bound Device Services.
Removed 0004- from the UCR filename.
Signed-off-by: Tom Brennan <[email protected]>
Updates based on discussion today, reviewing this UCR.
Renamed the UCR for clarity; emphasizing Device Metadata.
Dropped minor correction in README.md
Signed-off-by: Tom Brennan <[email protected]>
ci: add retry to mkdocs build stage
Signed-off-by: Ernesto Ojeda <[email protected]>
feat(microservices): Add NATS MessageBus Overview
Lists new options, build flag and simple jetstream example. Links to
README for complete option listing.
Signed-off-by: Alex Ullrich <[email protected]>
doc: updated the SDK-Go-API.md document to reflect the new functions of DeviceSDKService wrapper
Signed-off-by: Marc-Philippe Fuller <[email protected]>
fix: Remove scheduler unused fields and update data dictionary
fix edgexfoundry#787
Signed-off-by: Ginny Guan <[email protected]>
fix: Escape unintended macro templates, fail docs build on errors (edgexfoundry#814)
* fix: Escape marching Jinja test in CLI docs
* feat: Make builds fail on macro errors
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
feat: add build and run on ARM32
fixes edgexfoundry#685
Signed-off-by: jpwhitemn <[email protected]>
feat: add arm32 doc to nav bar
Signed-off-by: jpwhitemn <[email protected]>
feat: Referencing doc pages with latest alias (edgexfoundry#831)
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
Co-authored-by: Mengyi Wang <[email protected]>
feat: Document Core Metadata Device System Events
closes edgexfoundry#829
Signed-off-by: Leonard Goodell <[email protected]>
fix: Rename the existing UCR to not have leading sequence number (edgexfoundry#837)
* fix: Rename the existing UCR to not have leading sequence number
Also added notes to TOC on naming and order of UCRs and ADRs
Signed-off-by: Lenny Goodell <[email protected]>
Co-authored-by: Tom Brennan <[email protected]>
docs: Update MQTT example doc
Update MQTT example doc for Levski release
Close edgexfoundry#64
Signed-off-by: bruce <[email protected]>
feat: document core metadata units of measure capability
Signed-off-by: Chris Hung <[email protected]>
fix: Add kong restart step to use new admin token after re-setup
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
fix: Correct spelling of autostart option
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
feat: update uom configuration example
Signed-off-by: Chris Hung <[email protected]>
feat(microservices): Reading AES256 Protected Data
Add note on decrypting payloads protected with AESProtection. Include
python code from TAF as an example.
Fixes edgexfoundry#784
Signed-off-by: Alex Ullrich <[email protected]>
feat: Document Core Metadata Device System Events
closes edgexfoundry#829
Signed-off-by: Leonard Goodell <[email protected]>
Co-authored-by: Tom Brennan <[email protected]>
feat: document core metadata units of measure capability
Signed-off-by: Chris Hung <[email protected]>
Co-authored-by: Tom Brennan <[email protected]>
feat: update uom configuration example
Signed-off-by: Chris Hung <[email protected]>
fix: Change snap getting started to use consul management token (edgexfoundry#841)
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
docs: add management token (edgexfoundry#844)
close #3158
Signed-off-by: Valina Li <[email protected]>
Signed-off-by: Valina Li <[email protected]>
Update docs_src/design/ucr/Provision-Watch-via-Device-Metadata.md
Signed-off-by: Tom Brennan <[email protected]>
Co-authored-by: Farshid Tavakolizadeh <[email protected]>
Updates per review comments.
Signed-off-by: Tom Brennan <[email protected]>
ci: add retry to mkdocs build stage
Signed-off-by: Ernesto Ojeda <[email protected]>
feat(microservices): Add NATS MessageBus Overview
Lists new options, build flag and simple jetstream example. Links to
README for complete option listing.
Signed-off-by: Alex Ullrich <[email protected]>
doc: updated the SDK-Go-API.md document to reflect the new functions of DeviceSDKService wrapper
Signed-off-by: Marc-Philippe Fuller <[email protected]>
fix: Remove scheduler unused fields and update data dictionary
fix edgexfoundry#787
Signed-off-by: Ginny Guan <[email protected]>
fix: Escape unintended macro templates, fail docs build on errors (edgexfoundry#814)
* fix: Escape marching Jinja test in CLI docs
* feat: Make builds fail on macro errors
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
feat: add build and run on ARM32
fixes edgexfoundry#685
Signed-off-by: jpwhitemn <[email protected]>
feat: add arm32 doc to nav bar
Signed-off-by: jpwhitemn <[email protected]>
feat: Referencing doc pages with latest alias (edgexfoundry#831)
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
Co-authored-by: Mengyi Wang <[email protected]>
docs: Update MQTT example doc
Update MQTT example doc for Levski release
Close edgexfoundry#64
Signed-off-by: bruce <[email protected]>
feat: document core metadata units of measure capability
Signed-off-by: Chris Hung <[email protected]>
fix: Add kong restart step to use new admin token after re-setup
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
fix: Correct spelling of autostart option
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
feat: update uom configuration example
Signed-off-by: Chris Hung <[email protected]>
feat(microservices): Reading AES256 Protected Data
Add note on decrypting payloads protected with AESProtection. Include
python code from TAF as an example.
Fixes edgexfoundry#784
Signed-off-by: Alex Ullrich <[email protected]>
fix: Change snap getting started to use consul management token (edgexfoundry#841)
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
docs: add management token (edgexfoundry#844)
close #3158
Signed-off-by: Valina Li <[email protected]>
Signed-off-by: Valina Li <[email protected]>
feat: Add documentation of the EdgeX MessageBus
closes edgexfoundry#744, edgexfoundry#808
Signed-off-by: Leonard Goodell <[email protected]>
feat: Document NATS MessageBus Option
Add notes on NATS MessageBus implementation.
Signed-off-by: Alex Ullrich <[email protected]>
Signed-off-by: Leonard Goodell <[email protected]>
fix: Addressed 1st round of PR feedback
Signed-off-by: Leonard Goodell <[email protected]>
Update Ch-Metadata.md and TOC.
Restored missing line.
Fixing up lousy github signoff snafu:
Signed-off-by: Tom Brennan <[email protected]>
docs: add warning to GettingStartedusingDocker.md
Signed-off-by: melody <[email protected]>
fix: Correct relative link to snap configuration (edgexfoundry#852)
Signed-off-by: Mengyi Wang <[email protected]>
fix: Fix broken link to docker compose install
Docker seems to be actively updating their Compose documention, so the previous link
is no longer valid.
Signed-off-by: Leonard Goodell <[email protected]>
feat: Create Record and Replay UCR
related to edgexfoundry#471
Signed-off-by: Leonard Goodell <[email protected]>
fix: Renamed UCR without a sequence number
Signed-off-by: Leonard Goodell <[email protected]>
feat: Added requirements for capturing of Device/Device profiles
Signed-off-by: Leonard Goodell <[email protected]>
fix: Addressed PR feedback, restructured & added new requirments
Signed-off-by: Leonard Goodell <[email protected]>
fix: Addressed PR feedback for GZIP and timestamp requirment
Signed-off-by: Leonard Goodell <[email protected]>
feat: Changed status to Approved
Signed-off-by: Leonard Goodell <[email protected]>
refactor: [main] Rework device service list and add new camera device services
closes edgexfoundry#850
Signed-off-by: Leonard Goodell <[email protected]>
feat: Document the SecretProvider API for app and device services
closes edgexfoundry#847
Signed-off-by: Leonard Goodell <[email protected]>
fix: Correct typo in CommandClient function description
Signed-off-by: Leonard Goodell <[email protected]>
feat: Create UCR for Parent-Child Device Relationships
Signed-off-by: Tom Brennan [email protected]
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)
Signed-off-by: Tom Brennan <[email protected]>
Fixed the URL complaint/validation failure and added link to this PR.
The failure was probably due to CORS since the previous RFC address
is forwarded to this new one.
Added another Use Case extension.
Updated the README for the "local" process to validate and run the
mkdocs server, based on my experience.
Signed-off-by: Tom Brennan <[email protected]>
Added a separate UCR (edgexfoundry#3) for "Extending" Device Data, since it may end up
related.
Removed implementation stuff from edgexfoundry#2, and added requirements,
per review comments.
Added a Use Case extension for "gateway of gateways".
Signed-off-by: Tom Brennan <[email protected]>
Update docs_src/design/ucr/0002-Device-Parent-Child-Relationships.md
Signed-off-by: Tom Brennan <[email protected]>
Update docs_src/design/ucr/0002-Device-Parent-Child-Relationships.md
Signed-off-by: Tom Brennan <[email protected]>
Update docs_src/design/ucr/0002-Device-Parent-Child-Relationships.md
Signed-off-by: Tom Brennan <[email protected]>
Update docs_src/design/ucr/0002-Device-Parent-Child-Relationships.md
Signed-off-by: Tom Brennan <[email protected]>
Updates based on review comments.
Removed the second UCR from this PR.
Renamed to remove the 0002 from the filename.
Signed-off-by: Tom Brennan <[email protected]>
feat: Create System Events ADR
closes edgexfoundry#581
Signed-off-by: Leonard Goodell <[email protected]>
feat: Addressed PR feedback from Cloud
Signed-off-by: Leonard Goodell <[email protected]>
fix: Corrected the TOC description for the ADR
Signed-off-by: Leonard Goodell <[email protected]>
fix: Addressed typos and wording from PR reviews
Signed-off-by: Leonard Goodell <[email protected]>
fix: Addressed PR feeback
- Changed Publish Topic Prifix to be in configuration
- Clarified standard topic level vs addition levels for specific use
cases
- Fixed typos.
Signed-off-by: Leonard Goodell <[email protected]>
fix: Changed to use {PublishTopicPrefix} in topic definition
Signed-off-by: Leonard Goodell <[email protected]>
feat: Updated status to approved
Signed-off-by: Leonard Goodell <[email protected]>
ci: add retry to mkdocs build stage
Signed-off-by: Ernesto Ojeda <[email protected]>
Updated based on group discussion of this UCR. Primarily updated the
requirements section, absolving core services from entanglements in this
feature.
Signed-off-by: Tom Brennan <[email protected]>
Updated per review comment, putting burden on core-metadata to remove
child devices when the parent is removed.
Reverted extraneous suggestion in README.md
Signed-off-by: Tom Brennan <[email protected]>
One more thing to revert in README.md
Signed-off-by: Tom Brennan <[email protected]>
feat: Expand section on Provision Watchers (edgexfoundry#598) (edgexfoundry#865)
Signed-off-by: Iain Anderson <[email protected]>
docs: added usb camera streaming guide
Signed-off-by: brianointel <[email protected]>
docs: pr updates
Signed-off-by: brianointel <[email protected]>
docs: updated to use mplayer
Signed-off-by: brianointel <[email protected]>
Update docs_src/examples/Ch-ExamplesUsbDeviceService.md
Co-authored-by: Anthony Casagrande <[email protected]>
Signed-off-by: brianointel <[email protected]>
docs: pr updates
Signed-off-by: brianointel <[email protected]>
docs: pr updates
Signed-off-by: Brian Osburn <[email protected]>
docs: removed link
Signed-off-by: Brian Osburn <[email protected]>
docs: updated formatting
Signed-off-by: Brian Osburn <[email protected]>
docs: updated wording
Signed-off-by: Brian Osburn <[email protected]>
docs: updated capabilities
Signed-off-by: brianointel <[email protected]>
TomBrennan-Eaton
added a commit
to TomBrennan-Eaton/edgex-docs
that referenced
this issue
Sep 27, 2022
Noted that, for local builds, now also must have pip install
mkdocs-macros-plugin>=0.5
mkdocs now reports that Line 267 of some unamed .md file has:
INFO - [macros] - ERROR # _Macro Syntax Error_
_Line 267 in Markdown file:_ **expected token ':', got '}'**
Signed-off-by: Tom Brennan <[email protected]>
Update based on review comments.
In particular, added example and requirements to extend Provisioning
for south-bound Device Services.
Removed 0004- from the UCR filename.
Signed-off-by: Tom Brennan <[email protected]>
Updates based on discussion today, reviewing this UCR.
Renamed the UCR for clarity; emphasizing Device Metadata.
Dropped minor correction in README.md
Signed-off-by: Tom Brennan <[email protected]>
ci: add retry to mkdocs build stage
Signed-off-by: Ernesto Ojeda <[email protected]>
feat(microservices): Add NATS MessageBus Overview
Lists new options, build flag and simple jetstream example. Links to
README for complete option listing.
Signed-off-by: Alex Ullrich <[email protected]>
doc: updated the SDK-Go-API.md document to reflect the new functions of DeviceSDKService wrapper
Signed-off-by: Marc-Philippe Fuller <[email protected]>
fix: Remove scheduler unused fields and update data dictionary
fix edgexfoundry#787
Signed-off-by: Ginny Guan <[email protected]>
fix: Escape unintended macro templates, fail docs build on errors (edgexfoundry#814)
* fix: Escape marching Jinja test in CLI docs
* feat: Make builds fail on macro errors
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
feat: add build and run on ARM32
fixes edgexfoundry#685
Signed-off-by: jpwhitemn <[email protected]>
feat: add arm32 doc to nav bar
Signed-off-by: jpwhitemn <[email protected]>
feat: Referencing doc pages with latest alias (edgexfoundry#831)
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
Co-authored-by: Mengyi Wang <[email protected]>
feat: Document Core Metadata Device System Events
closes edgexfoundry#829
Signed-off-by: Leonard Goodell <[email protected]>
fix: Rename the existing UCR to not have leading sequence number (edgexfoundry#837)
* fix: Rename the existing UCR to not have leading sequence number
Also added notes to TOC on naming and order of UCRs and ADRs
Signed-off-by: Lenny Goodell <[email protected]>
Co-authored-by: Tom Brennan <[email protected]>
docs: Update MQTT example doc
Update MQTT example doc for Levski release
Close edgexfoundry#64
Signed-off-by: bruce <[email protected]>
feat: document core metadata units of measure capability
Signed-off-by: Chris Hung <[email protected]>
fix: Add kong restart step to use new admin token after re-setup
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
fix: Correct spelling of autostart option
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
feat: update uom configuration example
Signed-off-by: Chris Hung <[email protected]>
feat(microservices): Reading AES256 Protected Data
Add note on decrypting payloads protected with AESProtection. Include
python code from TAF as an example.
Fixes edgexfoundry#784
Signed-off-by: Alex Ullrich <[email protected]>
feat: Document Core Metadata Device System Events
closes edgexfoundry#829
Signed-off-by: Leonard Goodell <[email protected]>
Co-authored-by: Tom Brennan <[email protected]>
feat: document core metadata units of measure capability
Signed-off-by: Chris Hung <[email protected]>
Co-authored-by: Tom Brennan <[email protected]>
feat: update uom configuration example
Signed-off-by: Chris Hung <[email protected]>
fix: Change snap getting started to use consul management token (edgexfoundry#841)
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
docs: add management token (edgexfoundry#844)
close #3158
Signed-off-by: Valina Li <[email protected]>
Signed-off-by: Valina Li <[email protected]>
Update docs_src/design/ucr/Provision-Watch-via-Device-Metadata.md
Signed-off-by: Tom Brennan <[email protected]>
Co-authored-by: Farshid Tavakolizadeh <[email protected]>
Updates per review comments.
Signed-off-by: Tom Brennan <[email protected]>
ci: add retry to mkdocs build stage
Signed-off-by: Ernesto Ojeda <[email protected]>
feat(microservices): Add NATS MessageBus Overview
Lists new options, build flag and simple jetstream example. Links to
README for complete option listing.
Signed-off-by: Alex Ullrich <[email protected]>
doc: updated the SDK-Go-API.md document to reflect the new functions of DeviceSDKService wrapper
Signed-off-by: Marc-Philippe Fuller <[email protected]>
fix: Remove scheduler unused fields and update data dictionary
fix edgexfoundry#787
Signed-off-by: Ginny Guan <[email protected]>
fix: Escape unintended macro templates, fail docs build on errors (edgexfoundry#814)
* fix: Escape marching Jinja test in CLI docs
* feat: Make builds fail on macro errors
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
feat: add build and run on ARM32
fixes edgexfoundry#685
Signed-off-by: jpwhitemn <[email protected]>
feat: add arm32 doc to nav bar
Signed-off-by: jpwhitemn <[email protected]>
feat: Referencing doc pages with latest alias (edgexfoundry#831)
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
Co-authored-by: Mengyi Wang <[email protected]>
docs: Update MQTT example doc
Update MQTT example doc for Levski release
Close edgexfoundry#64
Signed-off-by: bruce <[email protected]>
feat: document core metadata units of measure capability
Signed-off-by: Chris Hung <[email protected]>
fix: Add kong restart step to use new admin token after re-setup
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
fix: Correct spelling of autostart option
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
feat: update uom configuration example
Signed-off-by: Chris Hung <[email protected]>
feat(microservices): Reading AES256 Protected Data
Add note on decrypting payloads protected with AESProtection. Include
python code from TAF as an example.
Fixes edgexfoundry#784
Signed-off-by: Alex Ullrich <[email protected]>
fix: Change snap getting started to use consul management token (edgexfoundry#841)
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
docs: add management token (edgexfoundry#844)
close #3158
Signed-off-by: Valina Li <[email protected]>
Signed-off-by: Valina Li <[email protected]>
feat: Add documentation of the EdgeX MessageBus
closes edgexfoundry#744, edgexfoundry#808
Signed-off-by: Leonard Goodell <[email protected]>
feat: Document NATS MessageBus Option
Add notes on NATS MessageBus implementation.
Signed-off-by: Alex Ullrich <[email protected]>
Signed-off-by: Leonard Goodell <[email protected]>
fix: Addressed 1st round of PR feedback
Signed-off-by: Leonard Goodell <[email protected]>
Update Ch-Metadata.md and TOC.
Restored missing line.
Fixing up lousy github signoff snafu:
Signed-off-by: Tom Brennan <[email protected]>
docs: add warning to GettingStartedusingDocker.md
Signed-off-by: melody <[email protected]>
fix: Correct relative link to snap configuration (edgexfoundry#852)
Signed-off-by: Mengyi Wang <[email protected]>
fix: Fix broken link to docker compose install
Docker seems to be actively updating their Compose documention, so the previous link
is no longer valid.
Signed-off-by: Leonard Goodell <[email protected]>
feat: Create Record and Replay UCR
related to edgexfoundry#471
Signed-off-by: Leonard Goodell <[email protected]>
fix: Renamed UCR without a sequence number
Signed-off-by: Leonard Goodell <[email protected]>
feat: Added requirements for capturing of Device/Device profiles
Signed-off-by: Leonard Goodell <[email protected]>
fix: Addressed PR feedback, restructured & added new requirments
Signed-off-by: Leonard Goodell <[email protected]>
fix: Addressed PR feedback for GZIP and timestamp requirment
Signed-off-by: Leonard Goodell <[email protected]>
feat: Changed status to Approved
Signed-off-by: Leonard Goodell <[email protected]>
refactor: [main] Rework device service list and add new camera device services
closes edgexfoundry#850
Signed-off-by: Leonard Goodell <[email protected]>
feat: Document the SecretProvider API for app and device services
closes edgexfoundry#847
Signed-off-by: Leonard Goodell <[email protected]>
fix: Correct typo in CommandClient function description
Signed-off-by: Leonard Goodell <[email protected]>
feat: Create UCR for Parent-Child Device Relationships
Signed-off-by: Tom Brennan [email protected]
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)
Signed-off-by: Tom Brennan <[email protected]>
Fixed the URL complaint/validation failure and added link to this PR.
The failure was probably due to CORS since the previous RFC address
is forwarded to this new one.
Added another Use Case extension.
Updated the README for the "local" process to validate and run the
mkdocs server, based on my experience.
Signed-off-by: Tom Brennan <[email protected]>
Added a separate UCR (edgexfoundry#3) for "Extending" Device Data, since it may end up
related.
Removed implementation stuff from edgexfoundry#2, and added requirements,
per review comments.
Added a Use Case extension for "gateway of gateways".
Signed-off-by: Tom Brennan <[email protected]>
Update docs_src/design/ucr/0002-Device-Parent-Child-Relationships.md
Signed-off-by: Tom Brennan <[email protected]>
Update docs_src/design/ucr/0002-Device-Parent-Child-Relationships.md
Signed-off-by: Tom Brennan <[email protected]>
Update docs_src/design/ucr/0002-Device-Parent-Child-Relationships.md
Signed-off-by: Tom Brennan <[email protected]>
Update docs_src/design/ucr/0002-Device-Parent-Child-Relationships.md
Signed-off-by: Tom Brennan <[email protected]>
Updates based on review comments.
Removed the second UCR from this PR.
Renamed to remove the 0002 from the filename.
Signed-off-by: Tom Brennan <[email protected]>
feat: Create System Events ADR
closes edgexfoundry#581
Signed-off-by: Leonard Goodell <[email protected]>
feat: Addressed PR feedback from Cloud
Signed-off-by: Leonard Goodell <[email protected]>
fix: Corrected the TOC description for the ADR
Signed-off-by: Leonard Goodell <[email protected]>
fix: Addressed typos and wording from PR reviews
Signed-off-by: Leonard Goodell <[email protected]>
fix: Addressed PR feeback
- Changed Publish Topic Prifix to be in configuration
- Clarified standard topic level vs addition levels for specific use
cases
- Fixed typos.
Signed-off-by: Leonard Goodell <[email protected]>
fix: Changed to use {PublishTopicPrefix} in topic definition
Signed-off-by: Leonard Goodell <[email protected]>
feat: Updated status to approved
Signed-off-by: Leonard Goodell <[email protected]>
ci: add retry to mkdocs build stage
Signed-off-by: Ernesto Ojeda <[email protected]>
Updated based on group discussion of this UCR. Primarily updated the
requirements section, absolving core services from entanglements in this
feature.
Signed-off-by: Tom Brennan <[email protected]>
Updated per review comment, putting burden on core-metadata to remove
child devices when the parent is removed.
Reverted extraneous suggestion in README.md
Signed-off-by: Tom Brennan <[email protected]>
One more thing to revert in README.md
Signed-off-by: Tom Brennan <[email protected]>
feat: Expand section on Provision Watchers (edgexfoundry#598) (edgexfoundry#865)
Signed-off-by: Iain Anderson <[email protected]>
docs: added usb camera streaming guide
Signed-off-by: brianointel <[email protected]>
docs: pr updates
Signed-off-by: brianointel <[email protected]>
docs: updated to use mplayer
Signed-off-by: brianointel <[email protected]>
Update docs_src/examples/Ch-ExamplesUsbDeviceService.md
Co-authored-by: Anthony Casagrande <[email protected]>
Signed-off-by: brianointel <[email protected]>
docs: pr updates
Signed-off-by: brianointel <[email protected]>
docs: pr updates
Signed-off-by: Brian Osburn <[email protected]>
docs: removed link
Signed-off-by: Brian Osburn <[email protected]>
docs: updated formatting
Signed-off-by: Brian Osburn <[email protected]>
docs: updated wording
Signed-off-by: Brian Osburn <[email protected]>
docs: updated capabilities
Signed-off-by: brianointel <[email protected]>
TomBrennan-Eaton
added a commit
to TomBrennan-Eaton/edgex-docs
that referenced
this issue
Sep 27, 2022
Noted that, for local builds, now also must have pip install
mkdocs-macros-plugin>=0.5
mkdocs now reports that Line 267 of some unamed .md file has:
INFO - [macros] - ERROR # _Macro Syntax Error_
_Line 267 in Markdown file:_ **expected token ':', got '}'**
Signed-off-by: Tom Brennan <[email protected]>
Update based on review comments.
In particular, added example and requirements to extend Provisioning
for south-bound Device Services.
Removed 0004- from the UCR filename.
Signed-off-by: Tom Brennan <[email protected]>
Updates based on discussion today, reviewing this UCR.
Renamed the UCR for clarity; emphasizing Device Metadata.
Dropped minor correction in README.md
Signed-off-by: Tom Brennan <[email protected]>
ci: add retry to mkdocs build stage
Signed-off-by: Ernesto Ojeda <[email protected]>
feat(microservices): Add NATS MessageBus Overview
Lists new options, build flag and simple jetstream example. Links to
README for complete option listing.
Signed-off-by: Alex Ullrich <[email protected]>
doc: updated the SDK-Go-API.md document to reflect the new functions of DeviceSDKService wrapper
Signed-off-by: Marc-Philippe Fuller <[email protected]>
fix: Remove scheduler unused fields and update data dictionary
fix edgexfoundry#787
Signed-off-by: Ginny Guan <[email protected]>
fix: Escape unintended macro templates, fail docs build on errors (edgexfoundry#814)
* fix: Escape marching Jinja test in CLI docs
* feat: Make builds fail on macro errors
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
feat: add build and run on ARM32
fixes edgexfoundry#685
Signed-off-by: jpwhitemn <[email protected]>
feat: add arm32 doc to nav bar
Signed-off-by: jpwhitemn <[email protected]>
feat: Referencing doc pages with latest alias (edgexfoundry#831)
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
Co-authored-by: Mengyi Wang <[email protected]>
feat: Document Core Metadata Device System Events
closes edgexfoundry#829
Signed-off-by: Leonard Goodell <[email protected]>
fix: Rename the existing UCR to not have leading sequence number (edgexfoundry#837)
* fix: Rename the existing UCR to not have leading sequence number
Also added notes to TOC on naming and order of UCRs and ADRs
Signed-off-by: Lenny Goodell <[email protected]>
Co-authored-by: Tom Brennan <[email protected]>
docs: Update MQTT example doc
Update MQTT example doc for Levski release
Close edgexfoundry#64
Signed-off-by: bruce <[email protected]>
feat: document core metadata units of measure capability
Signed-off-by: Chris Hung <[email protected]>
fix: Add kong restart step to use new admin token after re-setup
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
fix: Correct spelling of autostart option
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
feat: update uom configuration example
Signed-off-by: Chris Hung <[email protected]>
feat(microservices): Reading AES256 Protected Data
Add note on decrypting payloads protected with AESProtection. Include
python code from TAF as an example.
Fixes edgexfoundry#784
Signed-off-by: Alex Ullrich <[email protected]>
feat: Document Core Metadata Device System Events
closes edgexfoundry#829
Signed-off-by: Leonard Goodell <[email protected]>
Co-authored-by: Tom Brennan <[email protected]>
feat: document core metadata units of measure capability
Signed-off-by: Chris Hung <[email protected]>
Co-authored-by: Tom Brennan <[email protected]>
feat: update uom configuration example
Signed-off-by: Chris Hung <[email protected]>
fix: Change snap getting started to use consul management token (edgexfoundry#841)
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
docs: add management token (edgexfoundry#844)
close #3158
Signed-off-by: Valina Li <[email protected]>
Signed-off-by: Valina Li <[email protected]>
Update docs_src/design/ucr/Provision-Watch-via-Device-Metadata.md
Signed-off-by: Tom Brennan <[email protected]>
Co-authored-by: Farshid Tavakolizadeh <[email protected]>
Updates per review comments.
Signed-off-by: Tom Brennan <[email protected]>
ci: add retry to mkdocs build stage
Signed-off-by: Ernesto Ojeda <[email protected]>
feat(microservices): Add NATS MessageBus Overview
Lists new options, build flag and simple jetstream example. Links to
README for complete option listing.
Signed-off-by: Alex Ullrich <[email protected]>
doc: updated the SDK-Go-API.md document to reflect the new functions of DeviceSDKService wrapper
Signed-off-by: Marc-Philippe Fuller <[email protected]>
fix: Remove scheduler unused fields and update data dictionary
fix edgexfoundry#787
Signed-off-by: Ginny Guan <[email protected]>
fix: Escape unintended macro templates, fail docs build on errors (edgexfoundry#814)
* fix: Escape marching Jinja test in CLI docs
* feat: Make builds fail on macro errors
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
feat: add build and run on ARM32
fixes edgexfoundry#685
Signed-off-by: jpwhitemn <[email protected]>
feat: add arm32 doc to nav bar
Signed-off-by: jpwhitemn <[email protected]>
feat: Referencing doc pages with latest alias (edgexfoundry#831)
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
Co-authored-by: Mengyi Wang <[email protected]>
docs: Update MQTT example doc
Update MQTT example doc for Levski release
Close edgexfoundry#64
Signed-off-by: bruce <[email protected]>
feat: document core metadata units of measure capability
Signed-off-by: Chris Hung <[email protected]>
fix: Add kong restart step to use new admin token after re-setup
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
fix: Correct spelling of autostart option
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
feat: update uom configuration example
Signed-off-by: Chris Hung <[email protected]>
feat(microservices): Reading AES256 Protected Data
Add note on decrypting payloads protected with AESProtection. Include
python code from TAF as an example.
Fixes edgexfoundry#784
Signed-off-by: Alex Ullrich <[email protected]>
fix: Change snap getting started to use consul management token (edgexfoundry#841)
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
docs: add management token (edgexfoundry#844)
close #3158
Signed-off-by: Valina Li <[email protected]>
Signed-off-by: Valina Li <[email protected]>
feat: Add documentation of the EdgeX MessageBus
closes edgexfoundry#744, edgexfoundry#808
Signed-off-by: Leonard Goodell <[email protected]>
feat: Document NATS MessageBus Option
Add notes on NATS MessageBus implementation.
Signed-off-by: Alex Ullrich <[email protected]>
Signed-off-by: Leonard Goodell <[email protected]>
fix: Addressed 1st round of PR feedback
Signed-off-by: Leonard Goodell <[email protected]>
Update Ch-Metadata.md and TOC.
Restored missing line.
Fixing up lousy github signoff snafu:
Signed-off-by: Tom Brennan <[email protected]>
docs: add warning to GettingStartedusingDocker.md
Signed-off-by: melody <[email protected]>
fix: Correct relative link to snap configuration (edgexfoundry#852)
Signed-off-by: Mengyi Wang <[email protected]>
fix: Fix broken link to docker compose install
Docker seems to be actively updating their Compose documention, so the previous link
is no longer valid.
Signed-off-by: Leonard Goodell <[email protected]>
feat: Create Record and Replay UCR
related to edgexfoundry#471
Signed-off-by: Leonard Goodell <[email protected]>
fix: Renamed UCR without a sequence number
Signed-off-by: Leonard Goodell <[email protected]>
feat: Added requirements for capturing of Device/Device profiles
Signed-off-by: Leonard Goodell <[email protected]>
fix: Addressed PR feedback, restructured & added new requirments
Signed-off-by: Leonard Goodell <[email protected]>
fix: Addressed PR feedback for GZIP and timestamp requirment
Signed-off-by: Leonard Goodell <[email protected]>
feat: Changed status to Approved
Signed-off-by: Leonard Goodell <[email protected]>
refactor: [main] Rework device service list and add new camera device services
closes edgexfoundry#850
Signed-off-by: Leonard Goodell <[email protected]>
feat: Document the SecretProvider API for app and device services
closes edgexfoundry#847
Signed-off-by: Leonard Goodell <[email protected]>
fix: Correct typo in CommandClient function description
Signed-off-by: Leonard Goodell <[email protected]>
feat: Create UCR for Parent-Child Device Relationships
Signed-off-by: Tom Brennan [email protected]
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)
Signed-off-by: Tom Brennan <[email protected]>
Fixed the URL complaint/validation failure and added link to this PR.
The failure was probably due to CORS since the previous RFC address
is forwarded to this new one.
Added another Use Case extension.
Updated the README for the "local" process to validate and run the
mkdocs server, based on my experience.
Signed-off-by: Tom Brennan <[email protected]>
Added a separate UCR (edgexfoundry#3) for "Extending" Device Data, since it may end up
related.
Removed implementation stuff from edgexfoundry#2, and added requirements,
per review comments.
Added a Use Case extension for "gateway of gateways".
Signed-off-by: Tom Brennan <[email protected]>
Update docs_src/design/ucr/0002-Device-Parent-Child-Relationships.md
Signed-off-by: Tom Brennan <[email protected]>
Update docs_src/design/ucr/0002-Device-Parent-Child-Relationships.md
Signed-off-by: Tom Brennan <[email protected]>
Update docs_src/design/ucr/0002-Device-Parent-Child-Relationships.md
Signed-off-by: Tom Brennan <[email protected]>
Update docs_src/design/ucr/0002-Device-Parent-Child-Relationships.md
Signed-off-by: Tom Brennan <[email protected]>
Updates based on review comments.
Removed the second UCR from this PR.
Renamed to remove the 0002 from the filename.
Signed-off-by: Tom Brennan <[email protected]>
feat: Create System Events ADR
closes edgexfoundry#581
Signed-off-by: Leonard Goodell <[email protected]>
feat: Addressed PR feedback from Cloud
Signed-off-by: Leonard Goodell <[email protected]>
fix: Corrected the TOC description for the ADR
Signed-off-by: Leonard Goodell <[email protected]>
fix: Addressed typos and wording from PR reviews
Signed-off-by: Leonard Goodell <[email protected]>
fix: Addressed PR feeback
- Changed Publish Topic Prifix to be in configuration
- Clarified standard topic level vs addition levels for specific use
cases
- Fixed typos.
Signed-off-by: Leonard Goodell <[email protected]>
fix: Changed to use {PublishTopicPrefix} in topic definition
Signed-off-by: Leonard Goodell <[email protected]>
feat: Updated status to approved
Signed-off-by: Leonard Goodell <[email protected]>
ci: add retry to mkdocs build stage
Signed-off-by: Ernesto Ojeda <[email protected]>
Updated based on group discussion of this UCR. Primarily updated the
requirements section, absolving core services from entanglements in this
feature.
Signed-off-by: Tom Brennan <[email protected]>
Updated per review comment, putting burden on core-metadata to remove
child devices when the parent is removed.
Reverted extraneous suggestion in README.md
Signed-off-by: Tom Brennan <[email protected]>
One more thing to revert in README.md
Signed-off-by: Tom Brennan <[email protected]>
feat: Expand section on Provision Watchers (edgexfoundry#598) (edgexfoundry#865)
Signed-off-by: Iain Anderson <[email protected]>
docs: added usb camera streaming guide
Signed-off-by: brianointel <[email protected]>
docs: pr updates
Signed-off-by: brianointel <[email protected]>
docs: updated to use mplayer
Signed-off-by: brianointel <[email protected]>
Update docs_src/examples/Ch-ExamplesUsbDeviceService.md
Co-authored-by: Anthony Casagrande <[email protected]>
Signed-off-by: brianointel <[email protected]>
docs: pr updates
Signed-off-by: brianointel <[email protected]>
docs: pr updates
Signed-off-by: Brian Osburn <[email protected]>
docs: removed link
Signed-off-by: Brian Osburn <[email protected]>
docs: updated formatting
Signed-off-by: Brian Osburn <[email protected]>
docs: updated wording
Signed-off-by: Brian Osburn <[email protected]>
docs: updated capabilities
Signed-off-by: brianointel <[email protected]>
TomBrennan-Eaton
pushed a commit
to TomBrennan-Eaton/edgex-docs
that referenced
this issue
Sep 27, 2022
…oundry#865) Signed-off-by: Iain Anderson <[email protected]>
TomBrennan-Eaton
pushed a commit
to TomBrennan-Eaton/edgex-docs
that referenced
this issue
Sep 27, 2022
…oundry#865) Signed-off-by: Iain Anderson <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The following are undocumented features and need to be added to the device service section(s):
These issues reported by @tonyespy
The text was updated successfully, but these errors were encountered: