From 4a1bef83dbf2ebd1756f8b726d8a723255a025f7 Mon Sep 17 00:00:00 2001 From: Mohit Nagaraj Date: Mon, 16 Feb 2026 08:46:28 +0530 Subject: [PATCH] Add GitHub Pages deploy and site config Add a GitHub Actions workflow to build and deploy the site to GitHub Pages (on push to main and manual dispatch). Set site URL and favicon in astro.config.mjs, rename package to 'kubeorch-docs' in package.json, add public/CNAME (docs.kubeorch.dev) and a new favicon.ico while removing the SVG favicon, and add .claude/settings.local.json to grant local permissions for web fetch and npm/gh bash commands. Signed-off-by: Mohit Nagaraj --- .github/workflows/build.yml | 14 ++++++++++++++ .github/workflows/deploy.yml | 31 +++++++++++++++++++++++++++++++ .gitignore | 1 + astro.config.mjs | 2 ++ package-lock.json | 6 ++++++ package.json | 2 +- public/CNAME | 1 + public/favicon.ico | Bin 0 -> 4286 bytes public/favicon.svg | 1 - 9 files changed, 56 insertions(+), 2 deletions(-) create mode 100644 .github/workflows/build.yml create mode 100644 .github/workflows/deploy.yml create mode 100644 public/CNAME create mode 100644 public/favicon.ico delete mode 100644 public/favicon.svg diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..b37261a --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,14 @@ +name: Build Check + +on: + pull_request: + branches: [main] + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v5 + - name: Install, build, and upload your site + uses: withastro/action@v5 diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 0000000..01145cb --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,31 @@ +name: Deploy to GitHub Pages + +on: + push: + branches: [main] + workflow_dispatch: + +permissions: + contents: read + pages: write + id-token: write + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout your repository using git + uses: actions/checkout@v5 + - name: Install, build, and upload your site + uses: withastro/action@v5 + + deploy: + needs: build + runs-on: ubuntu-latest + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/.gitignore b/.gitignore index 880ae41..8e017c3 100644 --- a/.gitignore +++ b/.gitignore @@ -139,3 +139,4 @@ vite.config.js.timestamp-* vite.config.ts.timestamp-* /.astro /.vscode +.claude/settings.local.json diff --git a/astro.config.mjs b/astro.config.mjs index 94e3662..d6281da 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -4,9 +4,11 @@ import starlight from '@astrojs/starlight'; // https://astro.build/config export default defineConfig({ + site: 'https://docs.kubeorch.dev', integrations: [ starlight({ title: 'KubeOrch Docs', + favicon: '/favicon.ico', social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/KubeOrch' }], sidebar: [ { diff --git a/package-lock.json b/package-lock.json index 45362a0..afebd8c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1719,6 +1719,7 @@ "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.15.0.tgz", "integrity": "sha512-NZyJarBfL7nWwIq+FDL6Zp/yHEhePMNnnJ0y3qfieCrmNvYct8uvtiV41UvlSe6apAfk0fY1FbWx+NwfmpvtTg==", "license": "MIT", + "peer": true, "bin": { "acorn": "bin/acorn" }, @@ -1879,6 +1880,7 @@ "resolved": "https://registry.npmjs.org/astro/-/astro-5.13.4.tgz", "integrity": "sha512-Mgq5GYy3EHtastGXqdnh1UPuN++8NmJSluAspA5hu33O7YRs/em/L03cUfRXtc60l5yx5BfYJsjF2MFMlcWlzw==", "license": "MIT", + "peer": true, "dependencies": { "@astrojs/compiler": "^2.12.2", "@astrojs/internal-helpers": "0.7.2", @@ -5272,6 +5274,7 @@ } ], "license": "MIT", + "peer": true, "dependencies": { "nanoid": "^3.3.11", "picocolors": "^1.1.1", @@ -5752,6 +5755,7 @@ "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.49.0.tgz", "integrity": "sha512-3IVq0cGJ6H7fKXXEdVt+RcYvRCt8beYY9K1760wGQwSAHZcS9eot1zDG5axUbcp/kWRi5zKIIDX8MoKv/TzvZA==", "license": "MIT", + "peer": true, "dependencies": { "@types/estree": "1.0.8" }, @@ -6477,6 +6481,7 @@ "resolved": "https://registry.npmjs.org/vite/-/vite-6.3.5.tgz", "integrity": "sha512-cZn6NDFE7wdTpINgs++ZJ4N49W2vRp8LCKrn3Ob1kYNtOo21vfDoaV5GzBfLU4MovSAB8uNRm4jgzVQZ+mBzPQ==", "license": "MIT", + "peer": true, "dependencies": { "esbuild": "^0.25.0", "fdir": "^6.4.4", @@ -6691,6 +6696,7 @@ "resolved": "https://registry.npmjs.org/zod/-/zod-3.25.76.tgz", "integrity": "sha512-gzUt/qt81nXsFGKIFcC3YnfEAx5NkunCfnDlvuBSSFS02bcXu4Lmea0AFIUwbLWxWPx3d9p8S5QoaujKcNQxcQ==", "license": "MIT", + "peer": true, "funding": { "url": "https://github.com/sponsors/colinhacks" } diff --git a/package.json b/package.json index 12aa4cf..a2f219b 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "", + "name": "kubeorch-docs", "type": "module", "version": "0.0.1", "scripts": { diff --git a/public/CNAME b/public/CNAME new file mode 100644 index 0000000..f524570 --- /dev/null +++ b/public/CNAME @@ -0,0 +1 @@ +docs.kubeorch.dev diff --git a/public/favicon.ico b/public/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..4668e7b0a2c0290f6fc4c98fe8cc0af5ae4d9b54 GIT binary patch literal 4286 zcmcInNl+AL6mH9unu>>%8dEu#nBluOPz<(jG-QYFLmKs1Yq(U{e!DHmn|(Q-je z6oMKpqhMgV2Sh+%a6wU)01AkvL?9shDxfg)^1Z+N?;aSyTmn2^_y2dl@9pnzMVW`+ zl`9qgubg>aQI;!;@&*V?%6lMQ7eCmW?Pu4SHHuGjDqcNS@n**@a%-_mK`*%dAaIW! zyUeXQKru^k4RY`r_8iN^H9xC44Dy3B;oigVYR)CTtkv_qx>HHi;-Xa8mGT{Mor=$| zF7ay4&pf&_0NE9wYLlwG0cRDiD^21(UgLdUuZG@&_&S=L(_%zoP z9TH);Pg7sUz8`u_;(cO*{At8%(PTYqz9-+eIppYq`hl@IQFATy{rQQdLy})z2>sH$ z0d*SQbbP*##y8fCXWhDk5F=u485SN3h?qE%yTpAGW{a)m=T&_RfSa*Q6eN zZ(Jwl#L>yC9y(u>PN&O~XjksXh7ODka+}<%xr#hlanDHwa32f5g!!4db&!|__vEl$ z##nuHpA}nT7;>Zzuqg*N zK?nAAYVao-9_yoUI4tl(p|H^5RGHU^g=s(Q;MUbHx8M1ejjsYf+IEg#^7%EiH~$Or z<+x_dN#R#LhE88gq$d-PP3#a&PELX*$X|H~crlj$XTtZueout`MjTYiys?+=cip0g z0}rUGxtI~w4Dn|A!|{9_$77{~_#-#P1vFq(c|K7V(rhEo)D5;cL9_ z)>qNF8~cPWGRpT5`_#hM8Q*E+YX&}J3m@Rw)Zk|7g}v-|rpeGGJ)Rh+>IcQNzu-$V zr|kNZ_>yx@94J@^pS4r4ArsF>;0M$h@uhy!wo_#u#QZw_-C0XT@JC_YN!T+;EjPmfvL&wMobv}SZlJ#5hg5v~jKG)ibq7#?nq7Y$*dLjH5})gjdz$QHEIXro zH}bpcj$htBr3O%IQ|e#VAM3~1 zG7eG?!zNyjrL*P9A}-xS?R2lRhWbak#C>yjJ$!YIZna*erjAOXWA|Vio&PIc=p$tc zF7WOAXZyMTNqigE?n#_izZQQlu-cHz({@gUAS{2$SU+T$YE(}G(m z0rQV($_zAh5H`YooJroEss5(w5R2OVl=5oR;ny-685^LQmP;bWGS4_B3EC>kuRB4b z5S{kUH{)ozZF5pV9nVazhwheGHBfvO{>|Bd_*__ZhC|6xi)zmK%vEzd+I zzQ7Uo+xW=6XngdKqrpv>sRO`{#1Bzk%`t&5=l|}!HSp7UF>krovAsraaDJGxg7Z%L zz{vkO?dSKCA-A#pra1?~VzzO;rIl`hEbeCx+F!Vi8rsW6Z)6|wKKBHiN39%?zP0h4 zsDIo3nfxze3mHd>f1tXSE7XH}f6(24{DY&oUr}FIl?ng%qhGdX}{D1 zXASN@mi?H0QT~_D^7~2Xvn-Em!8i-SmppSZf9qPWnEo;5B>RBpFVB6M2U3>goPRif z{U?0u9mK<^ITKsdzJp2|&lz)a(wx&ce{`Ymr4*n>ki#+;i-t3+Ep6ex6Sg6BD9FhR~mKs!|0mV@Hyd3;b4mSG^|tk55=Dli&ezfOVv-)e0KHh) gDKVLkE6OX)in1`MDD$@)G!Oj$r1^~13{1xU7kbU~umAu6 literal 0 HcmV?d00001 diff --git a/public/favicon.svg b/public/favicon.svg deleted file mode 100644 index cba5ac1..0000000 --- a/public/favicon.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file