Skip to content

Commit

Permalink
publish docs to /docs/main
Browse files Browse the repository at this point in the history
  • Loading branch information
rukai committed Dec 2, 2024
1 parent 059dc73 commit b5fa882
Show file tree
Hide file tree
Showing 17 changed files with 11,956 additions and 2 deletions.
41 changes: 41 additions & 0 deletions .github/workflows/publish-to-pages.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: publish to github pages

on:
push:
branches: [ main ]

# Cancel already running jobs
concurrency:
group: publish_to_pages_${{ github.head_ref }}
cancel-in-progress: true

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

jobs:
build:
strategy:
matrix:
include:
- name: Publish website to Github Pages
runner: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.setup_pages.outputs.base_url }}
name: ${{ matrix.name }}
runs-on: ${{ matrix.runner }}
steps:
- uses: actions/checkout@v4
- name: Build website
run: cargo run -p website
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Upload pages
uses: actions/upload-pages-artifact@v3
with:
path: 'website/root'
- name: Deploy pages
uses: actions/deploy-pages@v4
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
/.project
/docs/book
/docs/mdbook_bin
/website/root
/website/shotover_repo_for_docs
/shotover-proxy/build/packages
/some_local_file
/test-helpers/src/connection/kafka/node/node_modules
85 changes: 85 additions & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ members = [
"custom-transforms-example",
"ec2-cargo",
"windsock-cloud-docker",
"website",
]
resolver = "2"

Expand Down
6 changes: 4 additions & 2 deletions docs/mdbook.sh
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@ set -e; set -u
if [ ! -d "mdbook_bin" ]; then
mkdir -p mdbook_bin
pushd mdbook_bin
curl -L https://github.com/rust-lang/mdBook/releases/download/v0.4.13/mdbook-v0.4.13-x86_64-unknown-linux-gnu.tar.gz | tar xvz
wget https://github.com/Michael-F-Bryan/mdbook-linkcheck/releases/download/v0.7.6/mdbook-linkcheck.x86_64-unknown-linux-gnu.zip -O linkcheck.zip
#curl -L https://github.com/rust-lang/mdBook/releases/download/v0.4.13/mdbook-v0.4.13-x86_64-unknown-linux-gnu.tar.gz | tar xvz
curl -L https://github.com/rust-lang/mdBook/releases/download/v0.4.13/mdbook-v0.4.13-x86_64-apple-darwin-gnu.tar.gz | tar -xvz
chmod +x mdbook
curl https://github.com/Michael-F-Bryan/mdbook-linkcheck/releases/download/v0.7.6/mdbook-linkcheck.x86_64-unknown-linux-gnu.zip -o linkcheck.zip
unzip linkcheck.zip
chmod +x mdbook-linkcheck
popd
Expand Down
12 changes: 12 additions & 0 deletions website/Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
[package]
name = "website"
version = "0.1.0"
edition = "2021"
license = "Apache-2.0"
publish = false

[dependencies]
subprocess.workspace = true
anyhow.workspace = true
rinja = "0.3.5"
semver = "1.0.23"
Binary file added website/assets/arrow_right.png
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 website/assets/favicon.ico
Binary file not shown.
Binary file added website/assets/logo.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 b5fa882

Please sign in to comment.