Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

poc: Cloud Manager Github Pages Docs #10002

Closed
Closed
46 changes: 46 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: Deploy Cloud Manager Docs

on:
push:
branches: [develop]
# clean up these before merging
workflow_dispatch:
pull_request:

permissions:
pages: write
id-token: write

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Setup Node
uses: actions/setup-node@v3
with:
node-version: 18
- uses: oven-sh/setup-bun@v1
with:
bun-version: latest
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Build with VitePress
working-directory: ./docs
run: bunx vitepress build
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: docs/.vitepress/dist
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
needs: build
runs-on: ubuntu-latest
name: Deploy
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -139,3 +139,6 @@ nohup.out
packages/manager/bundle_analyzer_report.html

**/manager/src/dev-tools/*.local.*

docs/.vitepress/cache
docs/.vitepress/dist
28 changes: 28 additions & 0 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import { generateSidebar } from "./sidebar";

export default {
title: "Cloud Manager Docs",
description: "Linode Cloud Manger Documentation",
srcDir: '../docs',
base: '/manager/',
themeConfig: {
logo: 'akamai-wave.svg',
nav: [
{ text: 'Home', link: '/' },
{ text: 'Getting Started', link: '/getting_started' }
],
search: {
provider: 'local'
},
sidebar: generateSidebar({
documentRootPath: '../docs',
hyphenToSpace: true,
underscoreToSpace: true,
capitalizeEachWords: true,
excludeFiles: ['PULL_REQUEST_TEMPLATE.md'],
}),
socialLinks: [
{ icon: 'github', link: 'https://github.com/linode/manager' }
]
}
}
Loading
Loading