Add GitHub Pages deploy and site config#1
Conversation
Summary of ChangesHello @mohit-nagaraj, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request establishes the foundational infrastructure for deploying the documentation site to GitHub Pages. It configures the necessary deployment workflow, updates core site settings for URL and favicon, and adjusts the project's package identification. Additionally, it prepares for custom domain usage and sets up local development permissions, streamlining the process for future contributions and site maintenance. Highlights
Changelog
Ignored Files
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request adds the necessary configuration to build and deploy the documentation site to GitHub Pages. The changes include setting the site URL, favicon, package name, and adding a CNAME file. A configuration file for the Claude AI assistant is also added. My review includes one high-severity security comment regarding the broad permissions granted in the new .claude/settings.local.json file, which should be scoped more narrowly.
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 <mohitnagaraj20@gmail.com>
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.
What this PR does / why we need it:
Which issue(s) this PR fixes (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close the issue(s) when PR gets merged):Fixes #
Special notes for your reviewer:
Checklist
This checklist is not enforcing, but it's a reminder of items that could be relevant to every PR.
Approvers are expected to review this list.
Release note: