forecast milestone complete

closes #73
trolie · Mar 30, 2024 · abdb9b7 · abdb9b7
1 parent 824d68f
commit abdb9b7
Show file tree

Hide file tree

Showing 7 changed files with 96 additions and 18 deletions.
diff --git a/cspell.json b/cspell.json
@@ -44,6 +44,7 @@
         ,"autoplay"
         ,"adrs"
         ,"puml"
+        ,"rgba"
     ],
     "import": []
 }
diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock
@@ -23,7 +23,7 @@ GEM
     commonmarker (0.23.10)
     concurrent-ruby (1.2.3)
     connection_pool (2.4.1)
-    dnsruby (1.71.0)
+    dnsruby (1.72.0)
       simpleidn (~> 0.2.1)
     drb (2.2.1)
     em-websocket (0.5.3)

diff --git a/docs/community-events/20240330-Forecasting-API-stable.md b/docs/community-events/20240330-Forecasting-API-stable.md
@@ -0,0 +1,65 @@
+---
+title: "Milestone: Forecasting API Stable"
+parent: Community Events
+---
+
+# Forecasting API Stable
+
+## Summary
+
+<img src="../images/TROLIE-springtime.jpg" style="float:right;padding-left:5px;box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.3)" width="280" height="280"/>
+
+The specification of the [Forecasting operations](/spec#tag/Forecasting) in
+TROLIE OpenAPI specification is now considered stable, closing the [associated
+milestone](https://github.com/trolie/spec/milestone/1). Specifically, no further
+changes are anticipated to the media types schemas and resource semantics (HTTP
+verbs and paths) for submitting forecasts and retrieving forecast snapshots.  We
+naming this release `1.0.0-wip-forecasting-stable` to reflect that fact that the
+specification is still under development, but we believe the forecasting
+operations effectively address the use cases that have been identified over the
+last several months.
+
+## Stable Use Cases
+
+Client developers should consider the specification stable in its support of the following use cases:
+
+* Submitting Forecast Ratings Proposals
+* Obtaining Forecast Ratings Proposal Status
+* Obtaining Forecast Limits Snapshots, including:
+  - "Slim" snapshots that provide just the determined limits
+  - Detailed snapshots that provide all of the inputs used by the Clearinghouse
+    Provider to determine the limits, including all proposals and overrides.
+
+## Improved and Expanded Documentation
+
+We continue to improve the documentation at [trolie.energy](/). In preparation
+for this release, we have:
+
+* Expanded the [TROLIE Concepts](../concepts) exposition
+* Extended the guide on [Forecast
+  Submittal](/example-narratives/submitting-forecasts)
+* Added an article on [Conditional GET](/articles/conditional-GET) and how to use
+  it to obtain snapshots efficiently
+* Described [how units are handled](/articles/how-units-are-handled) to
+  accommodate different practices by Reliability Coordinators
+* Added a concise description of [Forecast Windows](/articles/forecast-windows) and how
+  late forecast submissions are handled
+* Added a decision record on [Network Element Names and Naming
+  Authorities](/decision-log/naming) that describes how TROLIE addresses the
+  realities of different entities using different names for the same equipment.
+* Added a decision record on [directional ratings](/decision-log/directional-ratings).
+
+## Looking Ahead
+
+The [next milestone](https://github.com/trolie/spec/milestone/2) will stabilize
+Real-Time Ratings Proposals. [Future
+milestones](https://github.com/trolie/spec/milestones) will include handling
+temporary AAR exceptions, seasonal ratings, and defining the [peering
+profile](https://github.com/trolie/spec/issues/65#issuecomment-1994413248) which
+will specify how TROLIE implementations will integrate using only some some
+simple configuration.
+
+The version `1.0.0-wip-forecast-stable` will be updated accordingly **without**
+a version change until the next milestone is completed. However, any necessary
+changes to the forecasting operations will result in a version change and
+another announcement.
diff --git a/docs/decision-log/directional-ratings.md b/docs/decision-log/directional-ratings.md
@@ -5,7 +5,7 @@ parent: Decision Records
 
 ## Status
 
-* Status: `proposed`
+* Status: `Committed`
 * Issue Link: [GitHub Issue](https://github.com/trolie/spec/issues/6)
 
 ## Context

diff --git a/docs/decision-log/naming.md b/docs/decision-log/naming.md
@@ -5,7 +5,7 @@ parent: Decision Records
 
 ## Status
 
-* Status: `proposed`
+* Status: `Committed`
 * Issue Link: [GitHub Issue](https://github.com/trolie/spec/issues/9)
 
 ## Context

diff --git a/docs/images/TROLIE-springtime.jpg b/docs/images/TROLIE-springtime.jpg
diff --git a/docs/index.md b/docs/index.md
@@ -13,35 +13,47 @@ nav_order: 1
   <img alt="Official LF Energy Project logo" src="https://artwork.lfenergy.org/other/lf-energy-project/horizontal/color/lf-energy-project-horizontal-color.png" width="200" />
 </a>
 
-For general announcements and discussion, subscribe to our [Email List <i class="fa-solid fa-envelope"></i>](https://lists.lfenergy.org/g/trolie-general).
+For general announcements and discussion, subscribe to our [Email List <i
+class="fa-solid fa-envelope"></i>](https://lists.lfenergy.org/g/trolie-general).
 
 ***
 
 {: .announcement }
 
 > **Latest Updates** <i class="fa-solid fa-bullhorn"></i>
 >
-> * [Q&A](community-events/20240221-Intro-to-TROLIE#q--a) from the Intro to TROLIE webinar
-> * An article on [Conditional GET](articles/conditional-GET.md) and how to use it to obtain snapshots efficiently
-> * [How Units are Handled](articles/how-units-are-handled.md) to accommodate different practices by Reliability Coordinators
-> * A concise description of [Forecast Windows](articles/forecast-windows.md) and how late forecast submissions are handled
-> * A decision record on [Network Element Names and Naming Authorities](decision-log/naming)
-
+> The TROLIE maintainers are pleased to announce that the [Forecasting API](/spec#tag/Forecasting) specification is stable.
+> Read more in the [milestone announcement](./community-events/20240330-Forecasting-API-stable).
+>
+> If you are new to the project, consider watching the replay of the [Intro to TROLIE webinar](./community-events/20240221-Intro-to-TROLIE)
 
 # Introduction
 
-With FERC Order 881, North American Transmission Owners, Transmission Operators, Transmission Providers, and Reliability Coordinators must establish a means to exchange ratings information based on current and forecasted ambient conditions. There is no standards body with a mandate to define a technical specification for that exchange and no vendor consortium that is working toward a specification.
+With FERC Order 881, North American Transmission Owners, Transmission Operators,
+Transmission Providers, and Reliability Coordinators must establish a means to
+exchange ratings information based on current and forecasted ambient conditions.
+There is no standards body with a mandate to define a technical specification
+for that exchange and no vendor consortium that is working toward a
+specification.
 
-TROLIE started as a [MISO](https://www.misoenergy.org/) and [GE Vernova](https://www.gevernova.com/) collaboration and is now an [LF Energy project](https://lfenergy.org/projects/trolie/). Most organizations involved in the operation of the transmission system in North America now need to exchange ratings and related information in an automated, frequent manner. This project will help accelerate their implementation and simplify interoperability.
+TROLIE started as a [MISO](https://www.misoenergy.org/) and [GE
+Vernova](https://www.gevernova.com/) collaboration and is now an [LF Energy
+project](https://lfenergy.org/projects/trolie/). Most organizations involved in
+the operation of the transmission system in North America now need to exchange
+ratings and related information in an automated, frequent manner. This project
+will help accelerate their implementation and simplify interoperability.
 
 The project’s specific aims are:
 
-* <i class="fa-solid fa-hammer"></i> In Progress: Define an API specification for the exchange of ratings and ratings-related information to support organizations working to comply with FERC Order 881.
-* <i class="fa-solid fa-calendar-check"></i> TODO: A conformance program to provide vendors a means to demonstrate their compatibility with the above specification and signal their commitment to maintaining compatibility.
-* <i class="fa-solid fa-calendar-check"></i> TODO: An open commons for the development of clients of the API specification.
+* <i class="fa-solid fa-hammer"></i> In Progress: Define an API specification
+  for the exchange of ratings and ratings-related information to support
+  organizations working to comply with FERC Order 881.
 
+* <i class="fa-solid fa-calendar-check"></i> TODO: A conformance program to
+  provide vendors a means to demonstrate their compatibility with the above
+  specification and signal their commitment to maintaining compatibility.
 
-We are committed establishing a vendor-neutral specification and building an inclusive community.
+* <i class="fa-solid fa-calendar-check"></i> TODO: An open commons for the
+  development of clients of the API specification.
 
-
-[intro_webinar]: ./community-events/20240221-Intro-to-TROLIE
+We are committed establishing a vendor-neutral specification and building an inclusive community.