From 9928235cefdcad96cd1f8b3055897948d69f5ab7 Mon Sep 17 00:00:00 2001 From: Christopher Atkins Date: Mon, 26 Feb 2024 13:57:18 +0000 Subject: [PATCH] clean up --- .../20240221-Intro-to-TROLIE.md | 62 ++++++++----------- docs/index.md | 5 +- 2 files changed, 31 insertions(+), 36 deletions(-) diff --git a/docs/community-events/20240221-Intro-to-TROLIE.md b/docs/community-events/20240221-Intro-to-TROLIE.md index 312660c..5c2e09a 100644 --- a/docs/community-events/20240221-Intro-to-TROLIE.md +++ b/docs/community-events/20240221-Intro-to-TROLIE.md @@ -6,7 +6,7 @@ parent: Community Events # Summary On February 21, 2024 the maintainers conducted a webinar hosted by LF Energy to -introduce the project to the broader community. The recap page is [here][recap]. +introduce the project to the broader community. The replay page is [here][recap]. @@ -24,50 +24,42 @@ Q&A. # Q & A -
+### How does CIM relate to the TROLIE Specification? -

How does CIM relate to the TROLIE Specification?

+The maintainers are familiar with CIM, and it has influenced the development of +[TROLIE Concepts](https://trolie.energy/concepts). However, not all TROLIE +Concepts had an acceptable analogue in CIM and the traditional toolchain and +serialization conventions of CIM, e.g., RDF XML, do not align well with the +typical technology stack of a modern REST API. In short, TROLIE borrows what is +most useful from CIM's semantics while specifying a very conventional web API +using JSON media types. -

The maintainers are familiar with CIM, and it has influenced the - development of TROLIE Concepts. - However, not all TROLIE Concepts had an acceptable analogue in CIM and the - traditional toolchain and serialization conventions of CIM, e.g., RDF XML, do - not align well with the typical technology stack of a modern REST API. In - short, TROLIE borrows what is most useful from CIM's semantics while - specifying a very conventional web API using JSON media types.

-
+

Branches in our system model are nominated by a "From Bus" and a +"To Bus"; they are not assigned a (synthetic) unique identifier. How will we +be using the `resource-id` field to identify a branch when branches are not +assigned a single identifier?

-
+We created a new issue for this: [#54](https://github.com/trolie/spec/issues/54). +Please join the discussion there. -

Branches in our system model are nominated by a "From Bus" and a - "To Bus"; they are not assigned a (synthetic) unique identifier. How will we - be using the `resource-id` field to identify a branch when branches are not - assigned a single identifier?

-

We created a new issue for this: #54. Please join the discussion there.

+

How are the status/state of Real-Time and Forecast snapshots communicated +via TROLIE interfaces? How can we know from the TROLIE interface that a new +update for the snapshot values is available?

-
+We've made an intentional decision to adopt the certain design constraints, +including the restriction of the TROLIE Specification to classic REST patterns +and HTTP/1.1. Thus, we don't specify WebSockets, Server Sent Events, or +recommend HTTP long-polling, instead relying on the [Conditional GET +pattern](https://developer.mozilla.org/en-US/docs/Web/HTTP/Conditional_requests) +mediated by rate limiting. -
+We've created an issue to document using this pattern with TROLIE; see [issue +#56](https://github.com/trolie/spec/issues/56). -

How are the status/state of Real-Time and Forecast snapshots communicated - via TROLIE interfaces? How can we know from the TROLIE interface that a new - update for the snapshot values is available?

-

We've made an intentional decision to adopt the certain design constraints, - including the restriction of the TROLIE Specification to classic REST patterns - and HTTP/1.1. Thus, we don't specify WebSockets, Server Sent Events, or - recommend HTTP long-polling, instead relying on the Conditional - GET pattern mediated by rate limiting.

-

We've created an issue to document using this pattern with TROLIE; see issue #56.

-
- - - -[recap]: https://community.linuxfoundation.org/events/details/lfhq-lf-energy-presents-webinar-introduction-to-trolie \ No newline at end of file +[recap]: https://community.linuxfoundation.org/events/details/lfhq-lf-energy-presents-webinar-introduction-to-trolie diff --git a/docs/index.md b/docs/index.md index 4957fe2..cddeb2d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -21,7 +21,7 @@ For general announcements and discussion, subscribe to our [Email List **Project News** > -> We had 144 participants at our Intro to TROLIE webinar hosted by LF Energy on February 21st, 2024. The replay is now available for those who were unable to attend. +> The replay and Q&A is now available for the [Intro to TROLIE][intro_webinar] webinar. # Introduction @@ -38,3 +38,6 @@ The project’s specific aims are: We are committed establishing a vendor-neutral specification and building an inclusive community. + + +[intro_webinar]: ./community-events/20240221-Intro-to-TROLIE \ No newline at end of file