Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
1857a44
(+) init commit for the astro conversion from mdbook. We are using
erinxocon May 19, 2026
0513757
(*) add proper relative link support for markdown files in collections
erinxocon May 21, 2026
45d9c3c
(*) to avoid changing the workflow too much I've written this utility…
erinxocon May 27, 2026
18476a5
(+) migrate first heading to frontmatter title
erinxocon May 29, 2026
e961540
(*) move archive and readme to content folder, rename readme as index…
erinxocon May 29, 2026
acce443
(+) add logo assets to site
erinxocon Jun 2, 2026
39add2b
(+) create plugin that wraps any img content with a link to the unpro…
erinxocon Jun 2, 2026
7eaa155
(*) if create a grouped sidebar item, change the name of readme entr…
erinxocon Jun 3, 2026
1859671
(+) introduce base url since site is hosted at /tech-docs
erinxocon Jun 3, 2026
b63e900
(*) these articles have a period somehwere in their slug path, slugge…
erinxocon Jun 3, 2026
4137131
(*) update stating jobs for new astro pipeline
erinxocon Jun 4, 2026
5baecdf
(*) change to specifications and add styles to make pages without sub…
erinxocon Jun 8, 2026
13edcbe
(*) add and modify some css overrides for custom theme colors
erinxocon Jun 8, 2026
2ca89a3
(*) explicitly publish port for localhost dev
jacobgkau Jun 8, 2026
7a65b4e
(*) migrate to zst instead of gzip cause better, and lets test out fu…
erinxocon Jun 8, 2026
38244f5
(*) commit version hashes instead of tags to avoid
erinxocon Jun 8, 2026
c06e6e7
(*) migrate production deploy to new astro methods based on the stagi…
erinxocon Jun 9, 2026
b8c607d
(+) add dependabot functionality to keep github actions and pnpm pack…
erinxocon Jun 9, 2026
44a06df
(+) add thelio-mira-r5-n4 to astro docs location
erinxocon Jun 9, 2026
1ecb587
(+) add small border radius for images with CSS background
jacobgkau Jun 9, 2026
5044d06
(*) rename readme to specs
jacobgkau Jun 9, 2026
f526738
(*) format ToC & update content to accompany
jacobgkau Jun 9, 2026
27ad0a7
(*) rename file with middleware in the name so we know it is middlewa…
erinxocon Jun 10, 2026
c7f9ad6
(*) update links after transition from readme to specs naming convention
erinxocon Jun 10, 2026
67dfc70
(+) change site url based on prod of dev vite environments
erinxocon Jun 10, 2026
f6617f7
(*) slightly increase main content width
jacobgkau Jun 10, 2026
779d4c9
(+) update docs to reflect new way to build astro site via dev contai…
erinxocon Jun 10, 2026
10612f3
(*) docs: fix devcontainer exec commands, add Docker cleanup commands
jacobgkau Jun 10, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
10 changes: 10 additions & 0 deletions .devcontainer/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
FROM node:24-slim
RUN apt update && apt install -y --no-install-recommends ca-certificates git git-lfs sudo \
&& echo "node ALL=(ALL) NOPASSWD:ALL" > /etc/sudoers.d/node \
&& chmod 0440 /etc/sudoers.d/node
RUN corepack enable
WORKDIR /app

USER node

CMD ["/bin/bash"]
41 changes: 41 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
// README at: https://github.com/devcontainers/templates/tree/main/src/docker-existing-dockerfile
{
"name": "Existing Dockerfile",
"build": {
// Sets the run context to one level up instead of the .devcontainer folder.
"context": "..",
// Update the 'dockerFile' property if you aren't using the standard 'Dockerfile' filename.
"dockerfile": "./Dockerfile"
},

// Features to add to the dev container. More info: https://containers.dev/features.
// "features": {},

// Use 'forwardPorts' to make a list of ports inside the container available locally.
// "forwardPorts": [],

// Explicitly publish port (required for Podman to forward it).
"runArgs": ["-p=4321:4321"],

"postCreateCommand": "",

"mounts": ["source=devcontainer-bash-history,target=/history,type=volume"],

// Configure tool-specific properties.
"customizations": {
"vscode": {
"extensions": [
"astro-build.astro-vscode",
"unifiedjs.vscode-mdx",
"Vue.volar"
]
}
},

"remoteUser": "node",
"updateRemoteUserUID": true

// Uncomment to connect as an existing user other than the container default. More info: https://aka.ms/dev-containers-non-root.
// "remoteUser": "devcontainer"
}
5 changes: 5 additions & 0 deletions .git-blame-ignore-revs
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# first pass of prettier
0e21576c024b26dc134de42335d81f278e5b9f10

# another minor format
488d8aae38e9df19808a745e88cc82990e3f3418
17 changes: 17 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
day: "monday"
reviewers:
- "system76/web-engineering"

- package-ecosystem: "npm"
directory: "/"
schedule:
interval: "weekly"
day: "monday"
reviewers:
- "system76/web-engineering"
26 changes: 14 additions & 12 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,26 @@ name: CI
on:
pull_request:
types: [opened, reopened, synchronize]
push:
branches:
- '!master'

jobs:
Build:
Lint:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v4
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 #v6.0.3

- name: Setup pnpm
uses: pnpm/action-setup@0e279bb959325dab635dd2c09392533439d90093 #v6.0.8

- name: Setup Node
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e #v6.4.0
with:
lfs: true
node-version: 24
cache: pnpm

- name: Install mdBook
env:
MDBOOK_VERSION: 0.5.2
run: curl -sSL https://github.com/rust-lang/mdBook/releases/download/v${MDBOOK_VERSION}/mdbook-v${MDBOOK_VERSION}-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=/usr/local/bin
- name: Install dependencies
run: pnpm install --frozen-lockfile --dev

- name: Build
run: mdbook build
- name: Format check
run: pnpm format:check
40 changes: 33 additions & 7 deletions .github/workflows/deploy-prod.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,47 @@ jobs:

steps:
- name: Checkout
uses: actions/checkout@v4
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 #v6.0.3
with:
fetch-depth: 0
lfs: true

- name: Install mdBook
- name: Setup pnpm
uses: pnpm/action-setup@0e279bb959325dab635dd2c09392533439d90093 #v6.0.8

- name: Setup Node
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e #v6.4.0
with:
node-version: 24
cache: pnpm

- name: Restore cache from S3
run: |
aws s3 cp s3://${{ secrets.STAGING_AWS_S3_BUCKET }}/cache/${{ github.event.repository.name }}/astro-cache.tar.zst astro-cache.tar.zst || true
tar -xf astro-cache.tar.zst --use-compress-program "zstdmt" || true
env:
MDBOOK_VERSION: 0.5.2
run: curl -sSL https://github.com/rust-lang/mdBook/releases/download/v${MDBOOK_VERSION}/mdbook-v${MDBOOK_VERSION}-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=/usr/local/bin
AWS_ACCESS_KEY_ID: ${{ secrets.STAGING_AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.STAGING_AWS_SECRET_ACCESS_KEY }}
AWS_DEFAULT_REGION: ${{ secrets.STAGING_AWS_REGION }}

- name: Install
run: pnpm install --frozen-lockfile --prod

- name: Build
run: mdbook build
run: pnpm build

- name: Save cache to S3
run: |
tar -cf astro-cache.tar.zst node_modules/.astro --use-compress-program "zstdmt" || true
aws s3 cp astro-cache.tar.zst s3://${{ secrets.STAGING_AWS_S3_BUCKET }}/cache/${{ github.event.repository.name }}/astro-cache.tar.zst || true
env:
AWS_ACCESS_KEY_ID: ${{ secrets.STAGING_AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.STAGING_AWS_SECRET_ACCESS_KEY }}
AWS_DEFAULT_REGION: ${{ secrets.STAGING_AWS_REGION }}

- name: Deploy
run: aws s3 sync ./book s3://${{ secrets.PRODUCTION_AWS_S3_BUCKET }}/tech-docs --delete
run: aws s3 sync ./dist s3://${{ secrets.PRODUCTION_AWS_S3_BUCKET }}/tech-docs --delete
env:
AWS_ACCESS_KEY_ID: ${{ secrets.PRODUCTION_AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.PRODUCTION_AWS_SECRET_ACCESS_KEY }}
AWS_DEFAULT_REGION: ${{ secrets.PRODUCTION_AWS_REGION }}
AWS_DEFAULT_REGION: ${{ secrets.PRODUCTION_AWS_REGION }}
38 changes: 32 additions & 6 deletions .github/workflows/deploy-staging.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,46 @@ jobs:

steps:
- name: Checkout
uses: actions/checkout@v4
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 #v6.0.3
with:
fetch-depth: 0
lfs: true

- name: Install mdBook
- name: Setup pnpm
uses: pnpm/action-setup@0e279bb959325dab635dd2c09392533439d90093 #v6.0.8

- name: Setup Node
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e #v6.4.0
with:
node-version: 24
cache: pnpm

- name: Restore cache from S3
run: |
aws s3 cp s3://${{ secrets.STAGING_AWS_S3_BUCKET }}/cache/${{ github.event.repository.name }}/astro-cache.tar.zst astro-cache.tar.zst || true
tar -xf astro-cache.tar.zst --use-compress-program "zstdmt" || true
env:
MDBOOK_VERSION: 0.5.2
run: curl -sSL https://github.com/rust-lang/mdBook/releases/download/v${MDBOOK_VERSION}/mdbook-v${MDBOOK_VERSION}-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=/usr/local/bin
AWS_ACCESS_KEY_ID: ${{ secrets.STAGING_AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.STAGING_AWS_SECRET_ACCESS_KEY }}
AWS_DEFAULT_REGION: ${{ secrets.STAGING_AWS_REGION }}

- name: Install
run: pnpm install --frozen-lockfile --prod

- name: Build
run: mdbook build
run: pnpm build

# - name: Save cache to S3
# run: |
# tar -cf astro-cache.tar.zst node_modules/.astro --use-compress-program "zstdmt"
# aws s3 cp astro-cache.tar.zst s3://${{ secrets.STAGING_AWS_S3_BUCKET }}/cache/${{ github.event.repository.name }}/astro-cache.tar.zst
# env:
# AWS_ACCESS_KEY_ID: ${{ secrets.STAGING_AWS_ACCESS_KEY_ID }}
# AWS_SECRET_ACCESS_KEY: ${{ secrets.STAGING_AWS_SECRET_ACCESS_KEY }}
# AWS_DEFAULT_REGION: ${{ secrets.STAGING_AWS_REGION }}

- name: Deploy
run: aws s3 sync ./book s3://${{ secrets.STAGING_AWS_S3_BUCKET }}/tech-docs --delete
run: aws s3 sync ./dist s3://${{ secrets.STAGING_AWS_S3_BUCKET }}/tech-docs --delete
env:
AWS_ACCESS_KEY_ID: ${{ secrets.STAGING_AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.STAGING_AWS_SECRET_ACCESS_KEY }}
Expand Down
Loading