Skip to content

Commit

Permalink
add LFESS and Community spec details (#111)
Browse files Browse the repository at this point in the history
* add LFESS and Community spec details

Signed-off-by: Christopher Atkins <christopher316@gmail.com>

* add logos to repo

---------

Signed-off-by: Christopher Atkins <christopher316@gmail.com>
  • Loading branch information
caindy committed Jun 22, 2024
1 parent 0fb49a4 commit 8029d5a
Show file tree
Hide file tree
Showing 7 changed files with 104 additions and 18 deletions.
41 changes: 26 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,46 @@
[![Redocly OpenAPI lint](https://github.com/trolie/spec/actions/workflows/lint.yaml/badge.svg)](https://github.com/trolie/spec/actions/workflows/lint.yaml)
[![OWASP Top 10 Spectral lint](https://github.com/trolie/spec/actions/workflows/owasp.yaml/badge.svg)](https://github.com/trolie/spec/actions/workflows/owasp.yaml)

# TROLIE
# TROLIE 1.0 Specification Working Group

Transmission Ratings and Operating Limits Information Exchange
<img style="float:right" alt="Official LF Energy Standards and Specifications logo" src="docs/images/lf-energy-standards-and-specifications-horizontal-color.png" width="200">

[OpenAPI Specification docs](https://trolie.energy/spec)
The Transmission Ratings and Operating Limits Information Exchange (TROLIE) 1.0
specification is an LF Energy Standards and Specification Working Group. The
official website is [trolie.energy](https://trolie.energy).

### License

[Apache 2.0](https://github.com/TROLIE/spec/blob/1.0.0-wip/LICENSE)
## Scope

<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://artwork.lfenergy.org/other/lf-energy-project/horizontal/white/lf-energy-project-horizontal-white.png">
<source media="(prefers-color-scheme: light)" srcset="https://artwork.lfenergy.org/other/lf-energy-project/horizontal/color/lf-energy-project-horizontal-color.png">
<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>
The aim of the Working Group is to facilitate interoperability for organizations implementing FERC Order 881. In particular we are developing an [OpenAPI Specification](https://trolie.energy/spec). Please see [Scope](./Scope.md) for a thorough description of the Working Group's charge.

## To Specification Editors
## License

The OpenAPI specification is licensed under the [Community Specification License 1.0](Community_Specification_License.md).

Source code is otherwise licensed under [Apache 2.0](https://opensource.org/license/apache-2-0).

For more details see [LICENSE.md](LICENSE.md).

## Contributing

There are three roles for contributors: Maintainers, Editors, and Participants. See the [Governance Policy](Governance.md).

All contributions to the TROLIE Specification 1.0 Working Group are done under the [Community Specification Contributor License Agreement](Contributor_License_Agreement.md).

### Compiling the Site and Specification Locally

The `docs/` folder contains a Jekyll site for the GH Pages along with the yaml
that is used with `redocly bundle` to create the OpenAPI specification.

To simplify the local setup of the toolchain, a devcontainer is provided. This
will also install VS Code extensions to help with local editing.

If your company uses MITM, self-signed certificates through your Internet proxy
and/or proxies upstream RubyGem or npm repos, please follow the instructions in
the next section to get the local devcontainer editing experience working.
#### Self-Signed Certs and Repo Proxies

### Self-Signed Certs and Repo Proxies
If your company uses MITM, self-signed certificates through your Internet proxy
and/or proxies upstream RubyGem or npm repos, please follow these instructions
to get the local devcontainer editing experience working.

Put your company's self-signed cert in a PEM file at: `.devcontainer/root.pem`

Expand Down
2 changes: 1 addition & 1 deletion docs/_data/openapi-split.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ info:
title: Transmission Ratings and Operating Limits Information Exchange (TROLIE)
x-logo:
altText: "TROLIE logo"
url: "https://artwork.lfess.energy/projects/TROLIE/horizontal/color/TROLIE-horizontal-color.svg"
url: "images/TROLIE-horizontal-color.svg"
description: |
Pursuant to FERC Order 881, Transmission Providers are required to support
Expand Down
75 changes: 75 additions & 0 deletions docs/images/TROLIE-horizontal-color.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/TROLIE-icon-color.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ nav_order: 1
---


<img alt="TROLIE logo" src="https://artwork.lfess.energy/projects/TROLIE/icon/color/TROLIE-icon-color.png" width="200" style="float:right"/>
<img alt="TROLIE logo" src="images/TROLIE-icon-color.png" width="200" style="float:right"/>

# {{site.data.openapi-split.info.title}}


<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" />
<img alt="Official LF Energy Project logo" src="images/lf-energy-project-horizontal-color.png" width="200" />
</a>

For general announcements and discussion, subscribe to our [Email List <i
Expand Down

0 comments on commit 8029d5a

Please sign in to comment.