Skip to content

Commit dc14069

Browse files
authored
Add documentation site (#974)
* Add documentation site * Add section regarding HTTPs * PR feedback --------- Signed-off-by: Marc Tuduri <[email protected]>
1 parent fae24b7 commit dc14069

File tree

278 files changed

+3850
-776
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

278 files changed

+3850
-776
lines changed

.github/workflows/github-pages.yaml

+80
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
name: Deploy Documentation to Github Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
8+
# Allows you to run this workflow manually from the Actions tab
9+
workflow_dispatch:
10+
11+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
12+
permissions:
13+
contents: read
14+
pages: write
15+
id-token: write
16+
17+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
18+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
19+
concurrency:
20+
group: "pages"
21+
cancel-in-progress: false
22+
23+
# Default to bash
24+
defaults:
25+
run:
26+
shell: bash
27+
28+
jobs:
29+
# Build job
30+
build:
31+
runs-on: ubuntu-latest
32+
env:
33+
HUGO_VERSION: 0.115.4
34+
steps:
35+
- name: Install Hugo CLI
36+
run: |
37+
wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
38+
&& sudo dpkg -i ${{ runner.temp }}/hugo.deb
39+
#- name: Install Dart Sass
40+
# run: sudo snap install dart-sass
41+
- name: Checkout
42+
uses: actions/checkout@v3
43+
with:
44+
submodules: recursive
45+
fetch-depth: 0
46+
- name: Setup Pages
47+
id: pages
48+
uses: actions/configure-pages@v3
49+
- name: Install Node.js dependencies
50+
run: "[[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true"
51+
working-directory: ./docs
52+
- name: Build with Hugo
53+
env:
54+
# For maximum backward compatibility with Hugo modules
55+
HUGO_ENVIRONMENT: production
56+
HUGO_ENV: production
57+
run: |
58+
hugo \
59+
--gc \
60+
--minify \
61+
--baseURL "${{ steps.pages.outputs.base_url }}/"
62+
working-directory: ./docs
63+
- name: ls ./docs/public/api
64+
run: echo 'ls ./docs/public/api' && ls ./docs/public/api
65+
- name: Upload artifact
66+
uses: actions/upload-pages-artifact@v1
67+
with:
68+
path: ./docs/public
69+
70+
# Deployment job
71+
deploy:
72+
environment:
73+
name: github-pages
74+
url: ${{ steps.deployment.outputs.page_url }}
75+
runs-on: ubuntu-latest
76+
needs: build
77+
steps:
78+
- name: Deploy to GitHub Pages
79+
id: deployment
80+
uses: actions/deploy-pages@v2

0 commit comments

Comments
 (0)