diff --git a/README.md b/README.md index 7ab8433..e338d49 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,34 @@ [![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 +Official LF Energy Standards and Specifications logo -[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 - - - - Official LF Energy Project logo - +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. @@ -25,11 +36,11 @@ 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` diff --git a/docs/_data/openapi-split.yaml b/docs/_data/openapi-split.yaml index dd22f4a..9716375 100644 --- a/docs/_data/openapi-split.yaml +++ b/docs/_data/openapi-split.yaml @@ -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 diff --git a/docs/images/TROLIE-horizontal-color.svg b/docs/images/TROLIE-horizontal-color.svg new file mode 100644 index 0000000..0c1f4a0 --- /dev/null +++ b/docs/images/TROLIE-horizontal-color.svg @@ -0,0 +1,75 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/images/TROLIE-icon-color.png b/docs/images/TROLIE-icon-color.png new file mode 100644 index 0000000..3acf2bc Binary files /dev/null and b/docs/images/TROLIE-icon-color.png differ diff --git a/docs/images/lf-energy-project-horizontal-color.png b/docs/images/lf-energy-project-horizontal-color.png new file mode 100644 index 0000000..6dcff41 Binary files /dev/null and b/docs/images/lf-energy-project-horizontal-color.png differ diff --git a/docs/images/lf-energy-standards-and-specifications-horizontal-color.png b/docs/images/lf-energy-standards-and-specifications-horizontal-color.png new file mode 100644 index 0000000..6c96ce6 Binary files /dev/null and b/docs/images/lf-energy-standards-and-specifications-horizontal-color.png differ diff --git a/docs/index.md b/docs/index.md index 63df7d3..fda87ea 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,13 +4,13 @@ nav_order: 1 --- -TROLIE logo +TROLIE logo # {{site.data.openapi-split.info.title}} - Official LF Energy Project logo + Official LF Energy Project logo For general announcements and discussion, subscribe to our [Email List