Small Update (#312)

Author: directionless

.github/workflows/ci.yml

@@ -10,7 +10,7 @@ name: CI
 
 on:
   pull_request:
-    branches: ['main', 'source']
+    branches: ['main']
 
 env:
   NODE_CACHE_VERSION: 1

.github/workflows/deploy-to-pages.yml

@@ -10,7 +10,7 @@ name: Deploy to GitHub Pages
 
 on:
   push:
-    branches: ["main", "source"]
+    branches: ["main"]
   workflow_dispatch:
 
 env:

.github/workflows/release-pr.yml

@@ -20,7 +20,7 @@ jobs:
         steps:
             - uses: actions/checkout@v4
               with:
-                ref: source
+                ref: main
                 fetch-depth: 0
 
             - name: generate json files
@@ -40,7 +40,7 @@ jobs:
             # This is a gnarly command for updating an existing, or making a new PR
             # https://github.com/cli/cli/discussions/5792
             - name: Generate PR
-              run: gh pr edit 'release-${{ github.event.inputs.version }}' -b '${{ env.PR_BODY }}' -t '${{ env.PR_TITLE }}'  && (gh pr reopen '${{ env.BRANCH_NAME }}' || gh pr create --base source --fill --head 'release-${{ github.event.inputs.version }}')
+              run: gh pr edit 'release-${{ github.event.inputs.version }}' -b '${{ env.PR_BODY }}' -t '${{ env.PR_TITLE }}'  && (gh pr reopen '${{ env.BRANCH_NAME }}' || gh pr create --base main --fill --head 'release-${{ github.event.inputs.version }}')
               env:
                 GH_TOKEN: ${{ github.token }}
 

README.md

@@ -1,6 +1,17 @@
 # Osquery Website
 
-## Running the app locally
+The osquery website was written in js some time ago. It is not under active develelopment, and parts may be getting quite flakey. 
+
+## Deployment & Hosting
+
+The website is hosted on GitHub pages. It is deployed there using GitHub actions. As of 2025, this follows a normal github
+flow -- development on feature branches, PR to main. The deploy-to-pages happens on merge to main.
+
+In front of GitHub Pages is AWS Cloudfront. This is in the `infra` account. We should probably migrate off it.
+
+When debugging, be aware of a bit of a weirdness -- pages deploys to `https://osquery.github.io/osquery-site/` but that URL won't work, because several parts of the website generate absolute URLs rooted in `/`. This is okay behind the CDN though.
+
+## Development / Running the app locally
 
 Install all dependencies:
 
@@ -75,22 +86,6 @@ To upload a new community event, submit a PR adding a JSON file to the [communit
 
 Additionally, please add the newly-added filename to the [manifest file](/src/data/community_events/manifest.js).
 
-## Hosting & Deployment
-
-The website is hosted on github pages, off of the `master` branch. It is developed on the `source` branch. 
-
-To deploy:
-
-```shell
-cd .../osquery-site
-git checkout source
-git pull --rebase
-
-yarn deploy
-```
-
-This will create and push a commit to master with the update.
-
 ## License
 
 This repository is licensed under the terms of the