Skip to content

Commit

Permalink
Fixed the URL complaint/validation failure and added link to this PR.
Browse files Browse the repository at this point in the history
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]>
  • Loading branch information
TomBrennan-Eaton committed Sep 27, 2022
1 parent 17fd0fa commit 6eb6096
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,9 @@ To check that all the links in the documentation set are valid:

3. Run `make build` or `make serve`. Broken links will be listed at the end of the build process.

4. To render locally with link checking, you can instead use the command line: `ENABLED_HTMLPROOFER=true mkdocs serve`.
This will add the 5 minute delay for URL validation to the server startup.

Warning: the check for invalid / broken links does take some time and will add significantly to the build and serve times.

## "Publishing" your changes
Expand Down
8 changes: 6 additions & 2 deletions docs_src/design/ucr/0002-Device-Parent-Child-Relationships.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This UCR describes Use Cases for new Device metadata for Parent to Child Relatio
- Tom Brennan (Eaton)

## Change Log
- [pending](https://github.com/edgexfoundry/edgex-docs/pulls) (2022-07-15)
- [pending](https://github.com/edgexfoundry/edgex-docs/pull/800) (2022-07-18)


### Market Segments
Expand Down Expand Up @@ -62,7 +62,11 @@ as any devices without a configured relationship will probably be inferred to be
### Extensions to the main Use Case
1. In addition to parent-child relationships, other relationships might be indicated in this metadata, such as an
"extends" when an analytic service extends an existing south-bound device, adding new Device Resources beyond what the south-bound service provides.
2. It could be possible for north-bound or analytic services to add metadata of their choice, related to an individual device, in this "relationships" area.
2. Some services add "devices" which have no physical counterpart, eg, for an NTP client service where the "device"
serves simply as a container for the Resources necessary to configure and report the status of the service.
In these cases, it would be helpful for the other services if it described itself as something like a "system" device,
meaning one that doesn't have a physical (south-bound or hardware) counterpart.
3. It could be possible for north-bound or analytic services to add metadata of their choice, related to an individual device, in this "relationships" area.
This definitely muddies the clear objective of this UCR, but consideration of it might steer the ultimate solution.
As application service developers, we have felt at times the desire to "annotate" a device with something more formal than just another label;
if other reviewers agree with this notion, it can be adopted here, since it follows the same lines
Expand Down

0 comments on commit 6eb6096

Please sign in to comment.