Skip to content

Commit

Permalink
Initial commit of SSC Specification
Browse files Browse the repository at this point in the history
  • Loading branch information
miller79 committed Sep 21, 2023
1 parent 091dedd commit 00b027c
Show file tree
Hide file tree
Showing 5 changed files with 1,610 additions and 2 deletions.
11 changes: 11 additions & 0 deletions .github/scripts/create-redoc-static-html.sh
Original file line number Diff line number Diff line change
@@ -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!"
23 changes: 23 additions & 0 deletions .github/workflows/deploy-redoc-docs.yaml
Original file line number Diff line number Diff line change
@@ -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
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,11 @@
# ssc
Holds artifacts created by the SSC
![SSC Logo](images/SSC_logo_black.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-beta/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-beta/issues).
Binary file added images/SSC_logo_black.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 00b027c

Please sign in to comment.