Skip to content

Commit f5002f4

Browse files
klocke-iomarc1404
andauthored
Docs 2.0 (gardener#677)
* feat: add vitepress in a parallel solution to build and serve documentation * fix: base path * fix: add missing code block * feat: add post-processing for youtube element * fix: img tag * feat: add blog index.md * feat: fix path * feat: fix path * chore: cleanup * feat: handle numeric titles in blog folders and remove _index entries * fix: reduced greediness in title generation * chore: refactored sidebar * feat: add post processing for hugo alerts * style: Improve look and feel of persona filter * style: Adjust bottom padding of level 0 sidebar item * chore: add persona test * feat: add second post processing step to Dockerfile.dev * feat: Include index files as folder links in sidebar * feat: Include index files as folder links in community sidebar * feat: improve sidebar generation * chore: refactored dir structure * fix: content check for make file * feat: add GitHub workflow * fix: race condition * fix: exclusion * feat: remove flatten single dirs, need to be handed at link level to avoid breaking links * fix: add dirty fix for prefix on persona filtered sidebar * feat: add alias for data * feat: wip * feat: enhance content for empty index pages * chore: add a missing post-processing step * fix: taxonomie * feat: split security report * Feat: enable security report * Feat: enable api html rendering * fix: taxonomie for nested dirs * feat: add post-processing for docs/other-components/etcd-druid/ * fix: blog overview * fix: taxonomie for nested dirs * feat: improved footer * chore: remove dead code * chore: remove dead code * feat: remove outline from adapoters * fix: non persona sidebar * feat: improve history handling * feat: fixed white outline * feat: fixed white outline * feat: enable dedicated logos for darktheme * fix: syntax error * fix: logos * chore: color alicloud logo * fix: Use correct links in footer * feat: improve sidebar * fix: only apply persona sidebar to docs sections * style: Refresh GCP and Azure logos * fix: Restore search functionality * style: Remove aside on adopters page * style: Add active match for navbar items * fix: editlink * feat: remove prev and next except for blog entries * chore: Remove community bio page * feat: add missing title for index pages * chore: Configure syntax lang alais for golang and code * fix: excluded files # Conflicts: # .vitepress/config.mts # package.json * feat: enable pages deployment for new branch * feat: refine title on index page * feat: add colored social icons * chore: refine demo button text * feat: add hover effect to nav icons * fix: title on landing page * docs: Remove bio page section from community index * feat: add dynamic community sidebar * fix: Call useRoute outside of computed ref * fix: hover effect on social icons * chore: adapt references to master branch in prep of merge to master * chore: remove concourse job --------- Co-authored-by: Marc Vornetran <[email protected]>
1 parent 27cb615 commit f5002f4

File tree

158 files changed

+12296
-211
lines changed

Some content is hidden

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

158 files changed

+12296
-211
lines changed

.ci/404.sh

Lines changed: 0 additions & 47 deletions
This file was deleted.

.ci/build

Lines changed: 0 additions & 46 deletions
This file was deleted.

.ci/pipeline_definitions

Lines changed: 0 additions & 47 deletions
This file was deleted.

.docforge/documentation/documentation.yaml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,7 @@ structure:
2525
weight: 20
2626
aliases: ["/docs/guides/security-and-compliance/partial-disa-k8s-stig-shoot/"]
2727
- file: report.md
28-
multiSource:
29-
- /website/documentation/security-and-compliance/hardened-shoot-report/hardened_shoots_docu_report.md
30-
- /website/documentation/security-and-compliance/hardened-shoot-report/hardened_shoots_report.md
28+
source: /website/documentation/security-and-compliance/hardened-shoot-report/hardened_shoots_docu_report.md
3129
- file: kubernetes-hardening.md
3230
source: /website/documentation/security-and-compliance/kubernetes-hardening.md
3331
- dir: gardener

.docforge/website.yaml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,10 @@ structure:
1818
- dir: html
1919
structure:
2020
- file: /website/documentation/security-and-compliance/hardened-shoot-report/hardened_shoots_report.md
21+
22+
- dir: public
23+
structure:
24+
- fileTree: ../website/public
25+
- file: hardend_shoots_report.html
26+
source: /website/documentation/security-and-compliance/hardened-shoot-report/hardened_shoots_report.md
27+
- file: ../website/index.md

.dockerignore

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Ignore everything
2+
*
3+
4+
# Allow only specific directories and files
5+
!.vitepress/
6+
!hugo/content/
7+
!package.json
8+
!package-lock.json
9+
!post-processing/**
10+
!tsconfig.json
11+
12+
# Still ignore any node_modules in the allowed directories
13+
**/.DS_Store
14+
**/*.log
15+
.vitepress/.temp
16+
.vitepress/.cache
17+
.vitepress/dist
18+
19+
20+
# Ensure .env files are not included
21+
.env
22+
.env.*
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
name: Deploy VitePress site to Pages
2+
3+
on:
4+
# Runs on pushes targeting the `main` branch. Change this to `master` if you're
5+
# using the `master` branch as the default branch.
6+
push:
7+
branches: [master]
8+
pull_request:
9+
types: [ assigned, opened, synchronize, reopened ]
10+
# Allows you to run this workflow manually from the Actions tab
11+
workflow_dispatch:
12+
13+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
14+
permissions:
15+
contents: read
16+
pages: write
17+
id-token: write
18+
19+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
20+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
21+
concurrency:
22+
group: pages
23+
cancel-in-progress: false
24+
25+
jobs:
26+
# Build job
27+
build:
28+
runs-on: ubuntu-latest
29+
steps:
30+
- name: Checkout
31+
uses: actions/checkout@v4
32+
with:
33+
fetch-depth: 0 # Not needed if lastUpdated is not enabled
34+
# - uses: pnpm/action-setup@v3 # Uncomment this block if you're using pnpm
35+
# with:
36+
# version: 9 # Not needed if you've set "packageManager" in package.json
37+
# - uses: oven-sh/setup-bun@v1 # Uncomment this if you're using Bun
38+
- name: Setup Node
39+
uses: actions/setup-node@v4
40+
with:
41+
node-version: 24
42+
cache: npm # or pnpm / yarn
43+
- name: Setup Pages
44+
uses: actions/configure-pages@v5
45+
- name: Docforge
46+
run: |
47+
wget https://github.com/gardener/docforge/releases/download/v0.55.0/docforge-linux-amd64
48+
mv docforge-linux-amd64 docforge
49+
chmod +x docforge
50+
DOCFORGE_CONFIG=.docforge/config.yaml GITHUB_OAUTH_TOKEN=${{ secrets.GITHUB_TOKEN }} ./docforge
51+
- name: Install dependencies
52+
run: npm ci # or pnpm install / yarn install / bun install
53+
- name: Postprocessing Content
54+
run: |
55+
npm run post-processing-all
56+
57+
- name: Build with VitePress
58+
run: npm run docs:build # or pnpm docs:build / yarn docs:build / bun run docs:build
59+
- name: Upload artifact
60+
uses: actions/upload-pages-artifact@v3
61+
with:
62+
path: .vitepress/dist
63+
if: github.event_name != 'pull_request' # Skip upload on PRs
64+
65+
# Deployment job
66+
deploy:
67+
if: github.event_name != 'pull_request' # Skip deployment on PRs
68+
environment:
69+
name: github-pages
70+
url: ${{ steps.deployment.outputs.page_url }}
71+
needs: build
72+
runs-on: ubuntu-latest
73+
name: Deploy
74+
steps:
75+
- name: Deploy to GitHub Pages
76+
id: deployment
77+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)