Skip to content

Commit 5985ea3

Browse files
jeffreyavenjeffreyaven
committed
microsite
1 parent 1990a40 commit 5985ea3

File tree

3,156 files changed

+467273
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

3,156 files changed

+467273
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: '[BUG]'
5+
labels: 'bug'
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: "[FEATURE]"
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Feature Description**
11+
A clear and concise description of what you want to happen.
12+
13+
**Example(s)**
14+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
15+
16+
**Possible Approaches or Libraries to Consider**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/ISSUE_TEMPLATE/question.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
name: Question
3+
about: Pose a question to the StackQL team
4+
title: "[QUESTION]"
5+
labels: question
6+
assignees: ''
7+
8+
---
9+
10+
11+
## Question
12+
13+
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 :)
14+
15+
**Note**: Questions over github issues will be deprecated and retired once we settle on a platform / process ongoing.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
## Description
2+
3+
Please include a summary of the changes and the related issue(s). Please also include relevant motivation and context.
4+
5+
## Checklist
6+
7+
Please make sure that the following criteria are met:
8+
9+
- [ ] The PR title is descriptive.
10+
- [ ] I have ⭐'ed the [stackql](https://github.com/stackql/stackql) and this repo.
11+
12+
## Additional Notes
13+
14+
Add any additional information or context that might help the reviewers.

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

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- 'website/**'
9+
10+
jobs:
11+
build:
12+
name: Build Docusaurus
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v4
16+
with:
17+
fetch-depth: 0
18+
19+
- uses: actions/setup-node@v4
20+
with:
21+
node-version: 20
22+
cache: yarn
23+
cache-dependency-path: website/yarn.lock
24+
25+
- name: Install dependencies
26+
run: yarn install --frozen-lockfile
27+
working-directory: website
28+
29+
- name: Build website
30+
run: yarn build
31+
working-directory: website
32+
33+
- name: Upload Build Artifact
34+
uses: actions/upload-pages-artifact@v3
35+
with:
36+
path: website/build # Ensure the path is correctly set to the Docusaurus build output
37+
38+
deploy:
39+
name: Deploy to GitHub Pages
40+
needs: build
41+
42+
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
43+
permissions:
44+
pages: write # to deploy to Pages
45+
id-token: write # to verify the deployment originates from an appropriate source
46+
47+
# Deploy to the github-pages environment
48+
environment:
49+
name: github-pages
50+
url: ${{ steps.deployment.outputs.page_url }}
51+
52+
runs-on: ubuntu-latest
53+
steps:
54+
- name: Deploy to GitHub Pages
55+
id: deployment
56+
uses: actions/deploy-pages@v4
57+
with:
58+
working-directory: website/build # Ensures the correct directory is used for deployment

‎.github/workflows/star-check.yml‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Check if PR author has starred required repositories
2+
on:
3+
pull_request:
4+
types: [opened, synchronize, reopened]
5+
jobs:
6+
check-starred:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- name: Checkout code
10+
uses: actions/checkout@v4
11+
- name: Get PR author username and repo info
12+
id: get-info
13+
run: |
14+
echo "username=${{ github.event.pull_request.user.login }}" >> $GITHUB_ENV
15+
echo "current_repo=${{ github.event.repository.name }}" >> $GITHUB_ENV
16+
echo "current_owner=${{ github.repository_owner }}" >> $GITHUB_ENV
17+
- name: Pull github provider
18+
uses: stackql/[email protected]
19+
with:
20+
is_command: 'true'
21+
query: "REGISTRY PULL github;"
22+
- name: Run stackql query
23+
id: check-star
24+
uses: stackql/[email protected]
25+
with:
26+
test_query: |
27+
SELECT repo, count(*) as has_starred
28+
FROM github.activity.repo_stargazers
29+
WHERE owner = '${{ env.current_owner }}' and repo IN ('stackql','${{ env.current_repo }}')
30+
AND login = '${{ env.username }}'
31+
GROUP BY repo;
32+
expected_results_str: '[{"has_starred":"1","repo":"stackql"},{"has_starred":"1","repo":"${{ env.current_repo }}"}]'
33+
continue-on-error: true
34+
- name: Check if starred
35+
if: always() # Ensures this runs regardless of check-star outcome
36+
run: |
37+
if [ "${{ steps.check-star.outcome }}" = "success" ]; then
38+
echo "::notice::Thanks for your support!"
39+
else
40+
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)"
41+
exit 1
42+
fi

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

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Test deployment
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- main
7+
paths:
8+
- 'website/**'
9+
10+
jobs:
11+
test-deploy:
12+
name: Test deployment
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v4
16+
with:
17+
fetch-depth: 0
18+
19+
- uses: actions/setup-node@v4
20+
with:
21+
node-version: 20
22+
cache: yarn
23+
cache-dependency-path: website/yarn.lock
24+
25+
- name: Install dependencies
26+
run: yarn install --frozen-lockfile
27+
working-directory: website
28+
29+
- name: Test build website
30+
run: yarn build
31+
working-directory: website

‎fix_docs.sh‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
find website/docs/services -type f -name "*.md" -exec sed -i \
2+
-e 's/<table><tbody>/<table>\n<tbody>/g' \
3+
-e 's#</tbody></table>#</tbody>\n</table>#g' {} +
4+
5+
find website/docs/services -type f -name "*.md" -exec sed -i \
6+
-e 's#<tbody><tr>#<tbody>\n<tr>#g' {} +
7+
8+
find website/docs/services -type f -name "*.md" -exec sed -i \
9+
-e 's/\*/&#42;/g' {} +
10+

‎website/.gitignore‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
12+
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

‎website/README.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Website
2+
3+
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
4+
5+
## Installation
6+
7+
```bash
8+
yarn
9+
```
10+
11+
## Local Development
12+
13+
```bash
14+
yarn start
15+
```
16+
17+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18+
19+
## Build
20+
21+
```bash
22+
yarn build
23+
```
24+
25+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26+
27+
## Deployment
28+
29+
Using SSH:
30+
31+
```bash
32+
USE_SSH=true yarn deploy
33+
```
34+
35+
Not using SSH:
36+
37+
```bash
38+
GIT_USER=<Your GitHub username> yarn deploy
39+
```
40+
41+
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.

0 commit comments

Comments
 (0)