Documentation for Goose V1 (#638)

Co-authored-by: Wendy Tang <[email protected]>
Co-authored-by: Salman Mohammed <[email protected]>
Co-authored-by: Yingjie He <[email protected]>
Co-authored-by: Kalvin C <[email protected]>
Co-authored-by: Nahiyan Khan <[email protected]>
Co-authored-by: Bradley Axen <[email protected]>
Co-authored-by: lily-de <[email protected]>
Co-authored-by: Michael Neale <[email protected]>
Co-authored-by: Kalvin Chau <[email protected]>
Co-authored-by: marcelle <[email protected]>
Co-authored-by: Ebony Louis <[email protected]>
Co-authored-by: Angie Jones <[email protected]>

.github/workflows/deploy-docs-and-extensions.yml

@@ -0,0 +1,47 @@
+name: Deploy v1 Docs & Extensions # (/documentation and /extensions-site)
+
+on:
+  push:
+    branches:
+      - v1
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout the branch
+        uses: actions/checkout@v3
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20 
+
+      - name: Install dependencies and build docs
+        working-directory: ./documentation
+        run: |
+          npm install
+          npm run build
+
+      - name: Install dependencies and build extensions-site
+        working-directory: ./extensions-site
+        env:
+          VITE_BASENAME: "/goose/v1/extensions/" # Set the base URL here for the extensions site
+        run: |
+          npm install
+          npm run build
+
+      - name: Combine builds into one directory
+        run: |
+          mkdir combined-build
+          cp -r documentation/build/* combined-build/
+          mkdir -p combined-build/extensions
+          cp -r extensions-site/build/client/* combined-build/extensions/
+
+      - name: Deploy to gh-pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: combined-build
+          destination_dir: v1 # Deploy the site to the 'v1' subfolder

.gitignore

@@ -28,4 +28,15 @@ Cargo.lock
 /.hermit/
 /bin/
 
-debug_*.txt
+debug_*.txt
+
+# Docs
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader

CONTRIBUTING.md

@@ -1,5 +1,7 @@
 # Contributing
 
+Goose is Open Source!
+
 We welcome Pull Requests for general contributions! If you have a larger new feature or any questions on how to develop a fix, we recommend you open an [issue][issues] before starting.
 
 ## Prerequisites

documentation/.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*

documentation/README.md

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ 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
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ 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.