Merge pull request #1 from freightapis/initial-commit

Initial commit of SSC Specification

.github/scripts/create-redoc-static-html.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+echo "Getting started"
+
+# Bundle docs into zero-dependency HTML file
+npx redoc-cli bundle openapi.yaml && \
+mv redoc-static.html index.html && \
+echo "Changed name from redoc-static.html to index.html" && \
+# Add favicon
+sed -i '7 i \ \ <link rel="icon" type="image/png" href="images/favicon.png"/>' index.html && \
+echo -e "\nDone!"

.github/workflows/deploy-redoc-docs.yaml

@@ -0,0 +1,23 @@
+name: Build docs
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Build docs
+      run: ./.github/scripts/create-redoc-static-html.sh
+    - name: Deploy to GitHub Pages
+      uses: peaceiris/actions-gh-pages@v3 # https://github.com/peaceiris/actions-gh-pages
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: .
+        force_orphan: true
+        exclude_assets: '.github,openapi.yaml,.redocly.yaml,LICENSE,README.md,make.sh'
+
+permissions:
+  contents: write

LICENSE.md

@@ -0,0 +1,43 @@
+# SSC Scheduling Specification V1 License
+
+Specification: SSC_Scheduling_v1 ("Specification") <br />
+Version: 1.0 <br />
+Release: October 2, 2023
+
+## 1. LICENSE GRANTS
+
+**a. Compliant Implementations**. Each Licensor hereby grants You a perpetual, non-exclusive, non-transferable, worldwide, fully paid-up, royalty free, limited license (without the right to sublicense), subject to the provisions of Section 3, under any Necessary Claims of Licensor, to make, have made, use, sell and import Licensed Products. No right is granted with respect to any portion of Licensed Products that is not required to fully implement the Specification. No right, title, or interest in or to any trademarks, service marks, or trade names of any Licensor or its Affiliates is granted hereunder.
+
+**b. Grant-back**. The license granted under Section 1a is conditioned upon Your offering on fair, reasonable, non-discriminatory, and royalty-free terms, to any party seeking it from You, a perpetual, non-exclusive, non-transferable, worldwide, fully paid-up, royalty free license under any of Your Necessary Claims, on substantially the same terms of this agreement.
+
+**c. Defensive Termination**. If You make a written claim alleging that any Licensed Product infringes, directly or indirectly, any of your Necessary Claims, your license granted in Section 1a will immediately terminate, retroactive to the date the claim was made. 
+
+## 2. DISCLAIMER OF WARRANTIES
+
+THE SPECIFICATION AND LICENSES PROVIDED HEREUNDER ARE PROVIDED "AS IS". NO LICENSOR MAKES ANY REPRESENTATIONS OR WARRANTIES, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT (INCLUDING AS A CONSEQUENCE OF ANY PRACTICE OR IMPLEMENTATION OF THE SPECIFICATION), OR THAT THE CONTENTS OF THE SPECIFICATION ARE SUITABLE FOR ANY PURPOSE.
+
+## 3. LIMITATION OF LIABILITY
+
+TO THE EXTENT NOT PROHIBITED BY LAW, IN NO EVENT WILL ANY LICENSOR BE LIABLE FOR ANY DAMAGES, INCLUDING WITHOUT LIMITATION, LOST REVENUE, PROFITS OR DATA, OR FOR SPECIAL, INDIRECT, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF OR RELATED IN ANY WAY TO YOUR HAVING, IMPLEMENTING OR OTHERWISE USING THE SPECIFICATION, EVEN IF LICENSORS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 
+
+## 4. DEFINITIONS. For the purposes of this agreement:
+
+"**Affiliate**" means any entity controlled by or under common control with an entity. 
+
+"**Licensed Products**" means any product or service that, absent the license granted in Section 1a or 1b, would be infringed by any Necessary Claim, but only to the extent such product or service fully implements the Specification, including all its required interfaces and functionality.
+
+"**Licensor**" means each of the members of the Working Group who have agreed to this license for the Specification.
+
+"**Necessary Claims**" means any patent claims owned, controlled, or licensable by a party or its Affiliates that are necessarily infringed by implementing the Specification, where necessarily means there is no commercially reasonable alternative non-infringing way of implementing the Specification. Necessary Claims for the Specification do not include any claims that would not be infringed but for the implementation of elective elements expressly identified in the Specification.
+
+"**You**" means any recipient of the Specification.
+
+## 5. GENERAL TERMS
+
+**a.** Any action arising out of or related to this agreement will be governed by California law and applicable US law. The U.N. Convention for the International Sale of Goods and the choice of law rules of any jurisdiction will not apply.
+
+**b.** The Specification is subject to U.S. export control laws and may be subject to export or import regulations in other countries. You must comply strictly with all such laws and regulations and acknowledge that you have the responsibility to obtain such licenses to export, re-export or import as may be required.
+
+**c.** This agreement is the parties’ entire agreement relating to its subject matter. It supersedes all prior or contemporaneous oral or written communications, proposals, conditions, representations and warranties and prevails over any conflicting or additional terms of any quote, order, acknowledgment, or other communication between the parties relating to its subject matter during the term of this agreement. No modification to this agreement will be binding, unless in writing and signed by an authorized representative of each party.
+
+Except where otherwise noted, this document is subject to a [Creative Commons Attribution Share-Alike 2.0 License](https://creativecommons.org/licenses/by-sa/2.0/).

README.md

@@ -1,2 +1,11 @@
-# ssc
-Holds artifacts created by the SSC
+![SSC Logo](images/logos/SSC_logo.png)
+
+# SSC - Scheduling Standards Consortium
+
+Convoy, J.B. Hunt and Uber Freight formed the Scheduling Standards Consortium (SSC) to simplify the integration of systems across the fragmented ecosystem between shippers, carriers and intermediaries and create a more efficient appointment scheduling process.
+
+For more details about the Consortium, check out [freightapis.org](https://www.freightapis.org/).
+
+## Feedback and Discussion
+
+Please use the [discussions tab](https://github.com/freightapis/ssc/discussions) to leave feedback on the specification. If you find any specific issues with the specifications, please create an issue on the [issues tab](https://github.com/freightapis/ssc/issues).