microsite

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: '[BUG]'
+labels: 'bug'
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[FEATURE]"
+labels: enhancement
+assignees: ''
+
+---
+
+**Feature Description**
+A clear and concise description of what you want to happen.
+
+**Example(s)**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Possible Approaches or Libraries to Consider**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,15 @@
+---
+name: Question
+about: Pose a question to the StackQL team
+title: "[QUESTION]"
+labels: question
+assignees: ''
+
+---
+
+
+## Question
+
+This channel is an opportunity to ask ad-hoc questions to the `stackql` team.  This channel is in lieu of an official platform for ongoing discussions and questions.  Please ask your question :)
+
+**Note**: Questions over github issues will be deprecated and retired once we settle on a platform / process ongoing.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,14 @@
+## Description
+
+Please include a summary of the changes and the related issue(s). Please also include relevant motivation and context.
+
+## Checklist
+
+Please make sure that the following criteria are met:
+
+- [ ] The PR title is descriptive.
+- [ ] I have ⭐'ed the [stackql](https://github.com/stackql/stackql) and this repo.
+
+## Additional Notes
+
+Add any additional information or context that might help the reviewers.

.github/workflows/prod-web-deploy.yml

@@ -0,0 +1,58 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'website/**'      
+
+jobs:
+  build:
+    name: Build Docusaurus
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: yarn
+          cache-dependency-path: website/yarn.lock
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+        working-directory: website
+
+      - name: Build website
+        run: yarn build
+        working-directory: website
+
+      - name: Upload Build Artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: website/build # Ensure the path is correctly set to the Docusaurus build output
+
+  deploy:
+    name: Deploy to GitHub Pages
+    needs: build
+
+    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+    permissions:
+      pages: write # to deploy to Pages
+      id-token: write # to verify the deployment originates from an appropriate source
+
+    # Deploy to the github-pages environment
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+        with:
+          working-directory: website/build # Ensures the correct directory is used for deployment

.github/workflows/star-check.yml

@@ -0,0 +1,42 @@
+name: Check if PR author has starred required repositories
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+jobs:
+  check-starred:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+    - name: Get PR author username and repo info
+      id: get-info
+      run: |
+        echo "username=${{ github.event.pull_request.user.login }}" >> $GITHUB_ENV
+        echo "current_repo=${{ github.event.repository.name }}" >> $GITHUB_ENV
+        echo "current_owner=${{ github.repository_owner }}" >> $GITHUB_ENV
+    - name: Pull github provider
+      uses: stackql/stackql-exec@v2.2.1
+      with:
+        is_command: 'true'
+        query: "REGISTRY PULL github;"
+    - name: Run stackql query
+      id: check-star
+      uses: stackql/stackql-assert@v2.2.1
+      with:
+        test_query: |
+          SELECT repo, count(*) as has_starred
+          FROM github.activity.repo_stargazers
+          WHERE owner = '${{ env.current_owner }}' and repo IN ('stackql','${{ env.current_repo }}')
+          AND login = '${{ env.username }}'
+          GROUP BY repo;
+        expected_results_str: '[{"has_starred":"1","repo":"stackql"},{"has_starred":"1","repo":"${{ env.current_repo }}"}]'
+      continue-on-error: true
+    - name: Check if starred
+      if: always() # Ensures this runs regardless of check-star outcome
+      run: |
+        if [ "${{ steps.check-star.outcome }}" = "success" ]; then
+          echo "::notice::Thanks for your support!"
+        else
+          echo "::error::It seems you haven't starred the required repositories. Please star the following repos before proceeding: https://github.com/${{ env.current_owner }}/${{ env.current_repo }} (this repo) and https://github.com/stackql/stackql (our core repo)"
+          exit 1
+        fi

.github/workflows/test-web-deploy.yml

@@ -0,0 +1,31 @@
+name: Test deployment
+
+on:
+  pull_request:
+    branches:
+      - main
+    paths:
+      - 'website/**'
+
+jobs:
+  test-deploy:
+    name: Test deployment
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: yarn
+          cache-dependency-path: website/yarn.lock
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+        working-directory: website
+
+      - name: Test build website
+        run: yarn build
+        working-directory: website

fix_docs.sh

@@ -0,0 +1,10 @@
+find website/docs/services -type f -name "*.md" -exec sed -i \
+  -e 's/<table><tbody>/<table>\n<tbody>/g' \
+  -e 's#</tbody></table>#</tbody>\n</table>#g' {} +
+
+find website/docs/services -type f -name "*.md" -exec sed -i \
+  -e 's#<tbody><tr>#<tbody>\n<tr>#g' {} +
+
+find website/docs/services -type f -name "*.md" -exec sed -i \
+  -e 's/\*/&#42;/g' {} +
+

website/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

website/README.md

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+
+## Installation
+
+```bash
+yarn
+```
+
+## Local Development
+
+```bash
+yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+## Build
+
+```bash
+yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+## Deployment
+
+Using SSH:
+
+```bash
+USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```bash
+GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.