Skip to content

Commit

Permalink
clean up
Browse files Browse the repository at this point in the history
  • Loading branch information
@caindy
caindy committed Feb 26, 2024
1 parent 12702b5 commit 9928235
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 36 deletions.
62 changes: 27 additions & 35 deletions docs/community-events/20240221-Intro-to-TROLIE.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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].

<iframe width="560" height="315" src="https://www.youtube.com/embed/RRXwD8nyokc?si=qtT_ofwjmpGJITX6" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

Check warning on line 11 in docs/community-events/20240221-Intro-to-TROLIE.md

View workflow job for this annotation

GitHub Actions / spellcheck 

Unknown word (autoplay)

Expand All @@ -24,50 +24,42 @@ Q&A.

# Q & A

<section>
### How does CIM relate to the TROLIE Specification?

<h3>How does CIM relate to the TROLIE Specification?</h3>
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.

<p>The maintainers are familiar with CIM, and it has influenced the
development of <a href="https://trolie.energy/concepts">TROLIE Concepts</a>.
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.</p>

</section>
<h3>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?</h3>

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

<h3>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?</h3>

<p>We created a new issue for this: <a href="https://github.com/trolie/spec/issues/54">#54</a>. Please join the discussion there.</p>
<h3>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?</h3>

</section>
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.

<section>
We've created an issue to document using this pattern with TROLIE; see [issue
#56](https://github.com/trolie/spec/issues/56).

<h3>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?</h3>

<p>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 <a
href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Conditional_requests">Conditional
GET pattern</a> mediated by rate limiting.</p>

<p>We've created an issue to document using this pattern with TROLIE; see <a
href="https://github.com/trolie/spec/issues/56">issue #56</a>.</p>

</section>




[recap]: https://community.linuxfoundation.org/events/details/lfhq-lf-energy-presents-webinar-introduction-to-trolie
[recap]: https://community.linuxfoundation.org/events/details/lfhq-lf-energy-presents-webinar-introduction-to-trolie
5 changes: 4 additions & 1 deletion docs/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ For general announcements and discussion, subscribe to our [Email List <i class=

> **Project News** <i class="fa-solid fa-bullhorn"></i>
>
> We had 144 participants at our <a href="https://community.linuxfoundation.org/events/details/lfhq-lf-energy-presents-webinar-introduction-to-trolie/">Intro to TROLIE</a> 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
Expand All @@ -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

0 comments on commit 9928235

Please sign in to comment.