Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 8 additions & 28 deletions .github/workflows/docs-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,37 +17,17 @@ jobs:
with:
persist-credentials: false

- name: Setup ruby
uses: ruby/setup-ruby@efbf473cab83af4468e8606cc33eca9281bb213f # v1.256.0
- uses: actions/setup-node@v4
with:
ruby-version: '3.3'
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
cache-version: 0 # Increment this number if you need to re-download cached gems
working-directory: ./docs
node-version: 20.x

- name: Setup pages
id: pages
uses: actions/configure-pages@v5

- name: Build with Jekyll
run: bundle exec jekyll build --baseurl "$PAGES_PATH"
working-directory: ./docs
env:
PAGES_PATH: ${{ steps.pages.outputs.base_path }}

- name: Check links
- name: Build website
run: |
bundle exec htmlproofer \
--disable-external \
--assume_extension '.html' \
--swap-urls "^${PAGES_PATH}/:/" \
./_site
working-directory: ./docs
env:
PAGES_PATH: ${{ steps.pages.outputs.base_path }}
cd website
npm ci
npm run build

- name: Upload site assets as artifact
id: deployment
- name: Upload website artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./docs/_site
path: ./website/build
1 change: 1 addition & 0 deletions docs/imagecreator/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Image Creator
nav_order: 3
sidebar_position: 3
has_toc: false
---

Expand Down
1 change: 1 addition & 0 deletions docs/imagecreator/api/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
parent: Image Creator
title: API
nav_order: 1
sidebar_position: 1
---

# Image Creator API
1 change: 1 addition & 0 deletions docs/imagecreator/api/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Command line
parent: API
grand_parent: Image Creator
nav_order: 3
sidebar_position: 3
---

# Image Creator command line
Expand Down
4 changes: 4 additions & 0 deletions docs/imagecreator/api/configuration/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Configuration",
"position": 1
}
1 change: 1 addition & 0 deletions docs/imagecreator/api/configuration/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ parent: API
grand_parent: Image Creator
title : Configuration
nav_order: 2
sidebar_position: 1
has_toc: false
---

Expand Down
1 change: 1 addition & 0 deletions docs/imagecreator/developer-guide.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
parent: Image Creator
nav_order: 5
sidebar_position: 5
---

# Developers guide
Expand Down
1 change: 1 addition & 0 deletions docs/imagecreator/quick-start/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Quick Start
parent: Image Creator
nav_order: 1
sidebar_position: 1

---

Expand Down
1 change: 1 addition & 0 deletions docs/imagecustomizer/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Image Customizer
nav_order: 2
sidebar_position: 2
has_toc: false
---

Expand Down
4 changes: 4 additions & 0 deletions docs/imagecustomizer/api/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "API",
"position": 4
}
1 change: 1 addition & 0 deletions docs/imagecustomizer/api/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
parent: Image Customizer
title: API
nav_order: 4
sidebar_position: 4
---

# Image Customizer API
4 changes: 4 additions & 0 deletions docs/imagecustomizer/api/cli/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Command line",
"position": 1
}
1 change: 1 addition & 0 deletions docs/imagecustomizer/api/cli/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Command line
parent: API
grand_parent: Image Customizer
nav_order: 1
sidebar_position: 1
---

# Image Customizer command line
Expand Down
1 change: 1 addition & 0 deletions docs/imagecustomizer/api/cli/inject-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: inject-files
parent: Command line
ancestor: Image Customizer
nav_order: 1
sidebar_position: 1
---

# inject-files subcommand
Expand Down
4 changes: 4 additions & 0 deletions docs/imagecustomizer/api/configuration/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Configuration",
"position": 2
}
1 change: 1 addition & 0 deletions docs/imagecustomizer/api/configuration/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Configuration
parent: API
grand_parent: Image Customizer
nav_order: 2
sidebar_position: 2
has_toc: false
---

Expand Down
1 change: 1 addition & 0 deletions docs/imagecustomizer/api/cosi.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
parent: API
grand_parent: Image Customizer
nav_order: 3
sidebar_position: 3
---

# Composable Operating System Image (COSI) Specification
Expand Down
1 change: 1 addition & 0 deletions docs/imagecustomizer/concepts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
parent: Image Customizer
title: Concepts
nav_order: 3
sidebar_position: 3
has_toc: false
---

Expand Down
4 changes: 4 additions & 0 deletions docs/imagecustomizer/concepts/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Concepts",
"position": 3
}
1 change: 1 addition & 0 deletions docs/imagecustomizer/concepts/imagehistory.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
parent: Concepts
nav_order: 1
sidebar_position: 1
---

# Image History
Expand Down
1 change: 1 addition & 0 deletions docs/imagecustomizer/concepts/iso.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
parent: Concepts
title: ISO Support
nav_order: 3
sidebar_position: 3
---

# Image Customizer Live OS ISO Support
Expand Down
1 change: 1 addition & 0 deletions docs/imagecustomizer/concepts/liveos.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
parent: Concepts
title: Live OS
nav_order: 2
sidebar_position: 2
---

# Image Customizer Live OS Support
Expand Down
1 change: 1 addition & 0 deletions docs/imagecustomizer/concepts/pxe.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
parent: Concepts
title: PXE Support
nav_order: 4
sidebar_position: 4
---

# Image Customizer PXE Support
Expand Down
1 change: 1 addition & 0 deletions docs/imagecustomizer/concepts/sysext.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
parent: Concepts
nav_order: 7
sidebar_position: 7
---

# System extension
Expand Down
1 change: 1 addition & 0 deletions docs/imagecustomizer/concepts/things-to-avoid.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
parent: Concepts
nav_order: 5
sidebar_position: 5
---

# Things to avoid
Expand Down
4 changes: 4 additions & 0 deletions docs/imagecustomizer/concepts/verity/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Verity Image Recommendations",
"position": 6
}
1 change: 1 addition & 0 deletions docs/imagecustomizer/concepts/verity/cloud-init.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: cloud-init
parent: Verity Image Recommendations
sidebar_position: 2
---

# Verity and cloud-init
Expand Down
1 change: 1 addition & 0 deletions docs/imagecustomizer/concepts/verity/networking.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Networking
parent: Verity Image Recommendations
sidebar_position: 1
---

# Verity and Networking
Expand Down
1 change: 1 addition & 0 deletions docs/imagecustomizer/concepts/verity/sshd.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: sshd
parent: Verity Image Recommendations
sidebar_position: 4
---

# Verity and sshd
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: systemd-growfs-root
parent: Verity Image Recommendations
sidebar_position: 5
---

# Verity and systemd-growfs-root
Expand Down
1 change: 1 addition & 0 deletions docs/imagecustomizer/concepts/verity/verity.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
parent: Concepts
nav_order: 6
sidebar_position: 1
---

# Verity Image Recommendations
Expand Down
1 change: 1 addition & 0 deletions docs/imagecustomizer/concepts/verity/writable-var.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: var Partition
parent: Verity Image Recommendations
sidebar_position: 6
---

# Verity and `/var` Partition
Expand Down
1 change: 1 addition & 0 deletions docs/imagecustomizer/developer-guide.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
parent: Image Customizer
nav_order: 5
sidebar_position: 5
---

# Developers guide
Expand Down
4 changes: 4 additions & 0 deletions docs/imagecustomizer/how-to/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "How To",
"position": 2
}
4 changes: 4 additions & 0 deletions docs/imagecustomizer/how-to/azure-vm/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Create Azure VM",
"position": 2
}
1 change: 1 addition & 0 deletions docs/imagecustomizer/how-to/azure-vm/azure-vm.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Create Azure VM
parent: How To
nav_order: 2
sidebar_position: 1
has_toc: false
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Download Marketplace Image
parent: Create Azure VM
nav_order: 1
sidebar_position: 2
has_toc: false
---

Expand Down
1 change: 1 addition & 0 deletions docs/imagecustomizer/how-to/external-repos.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Install/Update Packages from External Repos
parent: How To
nav_order: 7
sidebar_position: 2
---

# Install/Update Packages from External Repos
Expand Down
1 change: 1 addition & 0 deletions docs/imagecustomizer/how-to/how-to.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: How To
parent: Image Customizer
nav_order: 2
sidebar_position: 1
---

# Image Customizer How To Guides
1 change: 1 addition & 0 deletions docs/imagecustomizer/how-to/live-iso.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Create LiveOS ISO
parent: How To
nav_order: 9
sidebar_position: 3
---

# Create a LiveOS ISO and run it in a VM
Expand Down
1 change: 1 addition & 0 deletions docs/imagecustomizer/how-to/verity-and-uki.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Create Verity and UKI image
parent: How To
nav_order: 9
sidebar_position: 4
---

# Create image with both verity and UKI
Expand Down
4 changes: 4 additions & 0 deletions docs/imagecustomizer/quick-start/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Quick Start",
"position": 1
}
1 change: 1 addition & 0 deletions docs/imagecustomizer/quick-start/quick-start-binary.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Quick Start - Binary
parent: Quick Start
grand_parent: Image Customizer
nav_order: 1
sidebar_position: 1
---

# Using the Image Customizer Binary
Expand Down
1 change: 1 addition & 0 deletions docs/imagecustomizer/quick-start/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Quick Start
parent: Image Customizer
nav_order: 1
sidebar_position: 1
has_toc: false
---

Expand Down
4 changes: 4 additions & 0 deletions docs/imagecustomizer/reference/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Reference",
"position": 6
}
1 change: 1 addition & 0 deletions docs/imagecustomizer/reference/building-packages.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
parent: Reference
nav_order: 1
sidebar_position: 1
---

# Building custom packages
Expand Down
1 change: 1 addition & 0 deletions docs/imagecustomizer/reference/clone-rpm-repo.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
parent: Reference
nav_order: 2
sidebar_position: 2
---

# Cloning an RPM repo
Expand Down
Loading
Loading