cosmetic enhancements mostly

* changed theme to Just the Docs * changed canonical url of the Redocly API viewer to /spec * added a favicon * run jekyll locally in safe mode to emulate GH Pages
trolie · Jan 13, 2024 · 01e5d35 · 01e5d35
1 parent d458050
commit 01e5d35
Show file tree

Hide file tree

Showing 10 changed files with 116 additions and 40 deletions.
diff --git a/.devcontainer/post.sh b/.devcontainer/post.sh
@@ -30,7 +30,7 @@ if [[ ("${1,,}" == "bundle") || ("${1,,}" == "start") ]]; then
 fi
 
 if [[ "${1,,}" == "start" ]]; then
-    cd $PARENT/docs && bundle update && nohup bundle exec jekyll serve  --force_polling --livereload > $PARENT/jekyll.out 2>&1 &
+    cd $PARENT/docs && bundle update && nohup bundle exec jekyll serve  --force_polling --livereload --safe > $PARENT/jekyll.out 2>&1 &
     sleep 4
     tail $PARENT/jekyll.out
     echo "Jekyll started, to monitor see $PARENT/jekyll.out"

diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@
 
 Transmission Ratings and Operating Limits Information Exchange
 
-[OpenAPI Specification docs](https://TROLIE.github.io/spec/)
+[OpenAPI Specification docs](https://trolie.energy/spec)
 
 ### License
 

diff --git a/cspell.json b/cspell.json
@@ -5,9 +5,11 @@
     "dictionaries": [],
     "words": [
         "excalidraw",
-        "TROLIE",
         "FERC",
-        "NERC"
+        "NERC",
+        "openapi",
+        "redoc",
+        "TROLIE"
     ],
     "ignoreWords": [],
     "import": []

diff --git a/docs/Gemfile b/docs/Gemfile
@@ -3,3 +3,7 @@ source ENV['GEM_REPO']
 gem "github-pages", "~> 228", group: :jekyll_plugins
 
 gem "webrick", "~> 1.8"
+
+gem "just-the-docs"
+
+gem 'jekyll-redirect-from'
diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock
@@ -34,11 +34,10 @@ GEM
       ffi (>= 1.15.0)
     eventmachine (1.2.7)
     execjs (2.9.1)
-    faraday (2.8.1)
-      base64
-      faraday-net_http (>= 2.0, < 3.1)
-      ruby2_keywords (>= 0.0.4)
-    faraday-net_http (3.0.2)
+    faraday (2.9.0)
+      faraday-net_http (>= 2.0, < 3.2)
+    faraday-net_http (3.1.0)
+      net-http
     ffi (1.16.3)
     forwardable-extended (2.6.0)
     gemoji (3.0.1)
@@ -207,6 +206,11 @@ GEM
       gemoji (~> 3.0)
       html-pipeline (~> 2.2)
       jekyll (>= 3.0, < 5.0)
+    just-the-docs (0.7.0)
+      jekyll (>= 3.8.5)
+      jekyll-include-cache
+      jekyll-seo-tag (>= 2.0)
+      rake (>= 12.3.1)
     kramdown (2.3.2)
       rexml
     kramdown-parser-gfm (1.1.0)
@@ -220,8 +224,10 @@ GEM
       jekyll (>= 3.5, < 5.0)
       jekyll-feed (~> 0.9)
       jekyll-seo-tag (~> 2.1)
-    minitest (5.20.0)
+    minitest (5.21.1)
     mutex_m (0.2.0)
+    net-http (0.4.1)
+      uri
     nokogiri (1.16.0-x86_64-linux)
       racc (~> 1.4)
     octokit (4.25.1)
@@ -231,6 +237,7 @@ GEM
       forwardable-extended (~> 2.6)
     public_suffix (4.0.7)
     racc (1.7.3)
+    rake (13.1.0)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
@@ -259,13 +266,16 @@ GEM
       unf_ext
     unf_ext (0.0.9.1)
     unicode-display_width (1.8.0)
+    uri (0.13.0)
     webrick (1.8.1)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
   github-pages (~> 228)
+  jekyll-redirect-from
+  just-the-docs
   webrick (~> 1.8)
 
 BUNDLED WITH

diff --git a/docs/_config.yml b/docs/_config.yml
@@ -1,17 +1,17 @@
 title: TROLIE
-email: your-email@example.com
+email: maintainers@trolie.energy
 
-description: >-
- Transmission Ratings and Operating Limits Information Exchange 
-url: "https://trolie.energy" # the base hostname & protocol for your site, e.g. http://example.com
-logo: https://artwork.lfenergy.org/projects/trolie/horizontal/color/TROLIE-horizontal-color.png
-# twitter_username: jekyllrb
+description: Transmission Ratings and Operating Limits Information Exchange 
+url: "https://trolie.energy"
+logo: https://artwork.lfenergy.org/projects/trolie/horizontal/color/TROLIE-horizontal-color.svg
+favicon_ico: images/TROLIE-icon-white.svg
 github_username: TROLIE
 
-# Build settings
-remote_theme: pages-themes/minimal@v0.2.0
-
-show_downloads: false
+theme: just-the-docs
 
 plugins:
   - jekyll-remote-theme
+  - jekyll-redirect-from
+
+whitelist:
+  - jekyll-redirect-from
diff --git a/docs/_data/openapi-split.yaml b/docs/_data/openapi-split.yaml
@@ -1,9 +1,8 @@
 openapi: 3.0.3
 info:
-  title: >-
-    Transmission Facility Ratings and Operating Limits Information Exchange
-    (TROLIE)
-  description: >
+  title: Transmission Ratings and Operating Limits Information Exchange (TROLIE)
+  description: >-
+
     Pursuant to FERC Order 881, Transmission Providers are required to support
 
     Ambient Adjusted Ratings (AARs) for most Transmission Facilities in their
@@ -79,7 +78,7 @@ info:
 
 
     <img src="images/TROLIE Ratings Provider interactions.excalidraw.png" alt="TROLIE Interactions by Ratings Provider" />
-  version: 0.1.0-wip
+  version: 1.0.0-wip
   contact:
     name: TROLIE Maintainers
     email: maintainers@trolie.energy

diff --git a/docs/images/TROLIE-icon-white.svg b/docs/images/TROLIE-icon-white.svg
diff --git a/docs/index.md b/docs/index.md
@@ -1,25 +1,37 @@
 ---
-# Feel free to add content and custom Front Matter to this file.
-# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
-
-#layout: home
 title: Home
 ---
 
 
+<img alt="TROLIE logo" src="images/TROLIE-icon-color.svg" width="200" style="float:right"/>
+
 # {{site.data.openapi-split.info.title}}
 
-[OpenAPI Specification docs](./redocly.html)
 
-### License
+[OpenAPI Specification docs](./spec)
 
+### License
 
 [Apache 2.0](https://github.com/TROLIE/spec/blob/1.0.0-wip/LICENSE)
-<picture>
-  <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">
-</picture>
-
-### Example:
-```json
-{% include_relative _data/examples/forecast-limits-slim.json %}
-```
+
+
+<a href="https://lfenergy.org/projects/trolie/">
+  <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>
+
+***
+
+# 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.
+
+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:
+
+* **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.
+* <span class="text-green-100 fw-500">TODO</span>: A conformance program to provide vendors a means to demonstrate their compatibility with the above specification and signal their commitment to maintaining compatibility.
+* <span class="text-green-100 fw-500">TODO</span>: An open commons for the development of clients of the API specification.
+
+
+We are committed establishing a vendor-neutral specification and building an inclusive community.
diff --git a/docs/redocly.html → docs/spec.html b/docs/redocly.html → docs/spec.html
@@ -1,3 +1,8 @@
+---
+title: OpenAPI Specification
+redirect_from:
+  - /redocly.html
+---
 <!DOCTYPE html>
 <html>
   <head>
@@ -18,7 +23,7 @@
     </style>
   </head>
   <body>
-    <redoc spec-url="openapi.yaml" />
+    <redoc spec-url="/openapi.yaml" />
     <script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"> </script>
   </body>
 </html>