Modify Use case template #2
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: jpwhitemn <jpwhite_mn@yahoo.com> Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>
farshidtz
force-pushed
the
use-case-template
branch
from
95b9783 to
d9e1844
Compare
farshidtz
force-pushed
the
use-case-template
branch
from
1c13edd to
e4d03ca
Compare
farshidtz
pushed a commit
that referenced
this pull request
Sep 26, 2022
…nce it may end up related. Removed implementation stuff from #2, and added requirements, per review comments. Added a Use Case extension for "gateway of gateways". Signed-off-by: Tom Brennan <ThomasJBrennan@eaton.com>
farshidtz
pushed a commit
that referenced
this pull request
Sep 29, 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 <ThomasJBrennan@eaton.com>
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 <ThomasJBrennan@eaton.com>
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 <ThomasJBrennan@eaton.com>
ci: add retry to mkdocs build stage
Signed-off-by: Ernesto Ojeda <ernesto.ojeda@intel.com>
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 <alex.ullrich@gmail.com>
doc: updated the SDK-Go-API.md document to reflect the new functions of DeviceSDKService wrapper
Signed-off-by: Marc-Philippe Fuller <marc-philippe.fuller@intel.com>
fix: Remove scheduler unused fields and update data dictionary
fix edgexfoundry#787
Signed-off-by: Ginny Guan <ginny@iotechsys.com>
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 <farshid.tavakolizadeh@canonical.com>
feat: add build and run on ARM32
fixes edgexfoundry#685
Signed-off-by: jpwhitemn <jpwhite_mn@yahoo.com>
feat: add arm32 doc to nav bar
Signed-off-by: jpwhitemn <jpwhite_mn@yahoo.com>
feat: Referencing doc pages with latest alias (edgexfoundry#831)
Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>
Co-authored-by: Mengyi Wang <mengyi.wang@canonical.com>
feat: Document Core Metadata Device System Events
closes edgexfoundry#829
Signed-off-by: Leonard Goodell <leonard.goodell@intel.com>
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 <leonard.goodell@intel.com>
Co-authored-by: Tom Brennan <ThomasJBrennan@eaton.com>
docs: Update MQTT example doc
Update MQTT example doc for Levski release
Close edgexfoundry#64
Signed-off-by: bruce <weichou1229@gmail.com>
feat: document core metadata units of measure capability
Signed-off-by: Chris Hung <chris@iotechsys.com>
fix: Add kong restart step to use new admin token after re-setup
Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>
fix: Correct spelling of autostart option
Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>
feat: update uom configuration example
Signed-off-by: Chris Hung <chris@iotechsys.com>
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 <alex.ullrich@gmail.com>
feat: Document Core Metadata Device System Events
closes edgexfoundry#829
Signed-off-by: Leonard Goodell <leonard.goodell@intel.com>
Co-authored-by: Tom Brennan <ThomasJBrennan@eaton.com>
feat: document core metadata units of measure capability
Signed-off-by: Chris Hung <chris@iotechsys.com>
Co-authored-by: Tom Brennan <ThomasJBrennan@eaton.com>
feat: update uom configuration example
Signed-off-by: Chris Hung <chris@iotechsys.com>
fix: Change snap getting started to use consul management token (edgexfoundry#841)
Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>
docs: add management token (edgexfoundry#844)
close #3158
Signed-off-by: Valina Li <valina.li@intel.com>
Signed-off-by: Valina Li <valina.li@intel.com>
Update docs_src/design/ucr/Provision-Watch-via-Device-Metadata.md
Signed-off-by: Tom Brennan <ThomasJBrennan@eaton.com>
Co-authored-by: Farshid Tavakolizadeh <email@farshid.ws>
Updates per review comments.
Signed-off-by: Tom Brennan <ThomasJBrennan@eaton.com>
ci: add retry to mkdocs build stage
Signed-off-by: Ernesto Ojeda <ernesto.ojeda@intel.com>
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 <alex.ullrich@gmail.com>
doc: updated the SDK-Go-API.md document to reflect the new functions of DeviceSDKService wrapper
Signed-off-by: Marc-Philippe Fuller <marc-philippe.fuller@intel.com>
fix: Remove scheduler unused fields and update data dictionary
fix edgexfoundry#787
Signed-off-by: Ginny Guan <ginny@iotechsys.com>
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 <farshid.tavakolizadeh@canonical.com>
feat: add build and run on ARM32
fixes edgexfoundry#685
Signed-off-by: jpwhitemn <jpwhite_mn@yahoo.com>
feat: add arm32 doc to nav bar
Signed-off-by: jpwhitemn <jpwhite_mn@yahoo.com>
feat: Referencing doc pages with latest alias (edgexfoundry#831)
Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>
Co-authored-by: Mengyi Wang <mengyi.wang@canonical.com>
docs: Update MQTT example doc
Update MQTT example doc for Levski release
Close edgexfoundry#64
Signed-off-by: bruce <weichou1229@gmail.com>
feat: document core metadata units of measure capability
Signed-off-by: Chris Hung <chris@iotechsys.com>
fix: Add kong restart step to use new admin token after re-setup
Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>
fix: Correct spelling of autostart option
Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>
feat: update uom configuration example
Signed-off-by: Chris Hung <chris@iotechsys.com>
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 <alex.ullrich@gmail.com>
fix: Change snap getting started to use consul management token (edgexfoundry#841)
Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>
docs: add management token (edgexfoundry#844)
close #3158
Signed-off-by: Valina Li <valina.li@intel.com>
Signed-off-by: Valina Li <valina.li@intel.com>
feat: Add documentation of the EdgeX MessageBus
closes edgexfoundry#744, edgexfoundry#808
Signed-off-by: Leonard Goodell <leonard.goodell@intel.com>
feat: Document NATS MessageBus Option
Add notes on NATS MessageBus implementation.
Signed-off-by: Alex Ullrich <alex.ullrich@gmail.com>
Signed-off-by: Leonard Goodell <leonard.goodell@intel.com>
fix: Addressed 1st round of PR feedback
Signed-off-by: Leonard Goodell <leonard.goodell@intel.com>
Update Ch-Metadata.md and TOC.
Restored missing line.
Fixing up lousy github signoff snafu:
Signed-off-by: Tom Brennan <ThomasJBrennan@eaton.com>
docs: add warning to GettingStartedusingDocker.md
Signed-off-by: melody <melody@iotechys.com>
fix: Correct relative link to snap configuration (edgexfoundry#852)
Signed-off-by: Mengyi Wang <mengyi.wang@canonical.com>
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 <leonard.goodell@intel.com>
feat: Create Record and Replay UCR
related to edgexfoundry#471
Signed-off-by: Leonard Goodell <leonard.goodell@intel.com>
fix: Renamed UCR without a sequence number
Signed-off-by: Leonard Goodell <leonard.goodell@intel.com>
feat: Added requirements for capturing of Device/Device profiles
Signed-off-by: Leonard Goodell <leonard.goodell@intel.com>
fix: Addressed PR feedback, restructured & added new requirments
Signed-off-by: Leonard Goodell <leonard.goodell@intel.com>
fix: Addressed PR feedback for GZIP and timestamp requirment
Signed-off-by: Leonard Goodell <leonard.goodell@intel.com>
feat: Changed status to Approved
Signed-off-by: Leonard Goodell <leonard.goodell@intel.com>
refactor: [main] Rework device service list and add new camera device services
closes edgexfoundry#850
Signed-off-by: Leonard Goodell <leonard.goodell@intel.com>
feat: Document the SecretProvider API for app and device services
closes edgexfoundry#847
Signed-off-by: Leonard Goodell <leonard.goodell@intel.com>
fix: Correct typo in CommandClient function description
Signed-off-by: Leonard Goodell <leonard.goodell@intel.com>
feat: Create UCR for Parent-Child Device Relationships
Signed-off-by: Tom Brennan ThomasJBrennan@eaton.com
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 <ThomasJBrennan@eaton.com>
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 <ThomasJBrennan@eaton.com>
Added a separate UCR (edgexfoundry#3) for "Extending" Device Data, since it may end up
related.
Removed implementation stuff from #2, and added requirements,
per review comments.
Added a Use Case extension for "gateway of gateways".
Signed-off-by: Tom Brennan <ThomasJBrennan@eaton.com>
Update docs_src/design/ucr/0002-Device-Parent-Child-Relationships.md
Signed-off-by: Tom Brennan <ThomasJBrennan@eaton.com>
Update docs_src/design/ucr/0002-Device-Parent-Child-Relationships.md
Signed-off-by: Tom Brennan <ThomasJBrennan@eaton.com>
Update docs_src/design/ucr/0002-Device-Parent-Child-Relationships.md
Signed-off-by: Tom Brennan <ThomasJBrennan@eaton.com>
Update docs_src/design/ucr/0002-Device-Parent-Child-Relationships.md
Signed-off-by: Tom Brennan <ThomasJBrennan@eaton.com>
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 <ThomasJBrennan@eaton.com>
feat: Create System Events ADR
closes edgexfoundry#581
Signed-off-by: Leonard Goodell <leonard.goodell@intel.com>
feat: Addressed PR feedback from Cloud
Signed-off-by: Leonard Goodell <leonard.goodell@intel.com>
fix: Corrected the TOC description for the ADR
Signed-off-by: Leonard Goodell <leonard.goodell@intel.com>
fix: Addressed typos and wording from PR reviews
Signed-off-by: Leonard Goodell <leonard.goodell@intel.com>
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 <leonard.goodell@intel.com>
fix: Changed to use {PublishTopicPrefix} in topic definition
Signed-off-by: Leonard Goodell <leonard.goodell@intel.com>
feat: Updated status to approved
Signed-off-by: Leonard Goodell <leonard.goodell@intel.com>
ci: add retry to mkdocs build stage
Signed-off-by: Ernesto Ojeda <ernesto.ojeda@intel.com>
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 <ThomasJBrennan@eaton.com>
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 <ThomasJBrennan@eaton.com>
One more thing to revert in README.md
Signed-off-by: Tom Brennan <ThomasJBrennan@eaton.com>
feat: Expand section on Provision Watchers (edgexfoundry#598) (edgexfoundry#865)
Signed-off-by: Iain Anderson <iain@iotechsys.com>
docs: added usb camera streaming guide
Signed-off-by: brianointel <brian.j.osburn@intel.com>
docs: pr updates
Signed-off-by: brianointel <brian.j.osburn@intel.com>
docs: updated to use mplayer
Signed-off-by: brianointel <brian.j.osburn@intel.com>
Update docs_src/examples/Ch-ExamplesUsbDeviceService.md
Co-authored-by: Anthony Casagrande <anthony.j.casagrande@intel.com>
Signed-off-by: brianointel <brian.j.osburn@intel.com>
docs: pr updates
Signed-off-by: brianointel <brian.j.osburn@intel.com>
docs: pr updates
Signed-off-by: Brian Osburn <brian.j.osburn@intel.com>
docs: removed link
Signed-off-by: Brian Osburn <brian.j.osburn@intel.com>
docs: updated formatting
Signed-off-by: Brian Osburn <brian.j.osburn@intel.com>
docs: updated wording
Signed-off-by: Brian Osburn <brian.j.osburn@intel.com>
docs: updated capabilities
Signed-off-by: brianointel <brian.j.osburn@intel.com>
farshidtz
pushed a commit
that referenced
this pull request
Nov 11, 2022
…ce Data, since it may end up related. Removed implementation stuff from #2, and added requirements, per review comments. Added a Use Case extension for "gateway of gateways". Signed-off-by: Tom Brennan <ThomasJBrennan@eaton.com>
farshidtz
pushed a commit
that referenced
this pull request
Nov 11, 2022
…nce it may end up related. Removed implementation stuff from #2, and added requirements, per review comments. Added a Use Case extension for "gateway of gateways". Signed-off-by: Tom Brennan <ThomasJBrennan@eaton.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Co-authored-by: jpwhitemn jpwhite_mn@yahoo.com
Signed-off-by: Farshid Tavakolizadeh farshid.tavakolizadeh@canonical.com
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: