CI/CD for docs

Author: anoopkarnik

.github/workflows/docs.yml

@@ -0,0 +1,41 @@
+name: Build and Deploy Docs to AWS S3
+
+on:
+    push:
+        branches:
+            - main
+        paths:
+            - 'apps/docs/**'    
+  
+jobs:
+    deploy:
+        runs-on: ubuntu-latest
+
+        steps:
+            # Step 1: Check out the repository
+            - name: Checkout code
+              uses: actions/checkout@v3
+    
+            # Step 2: Set up Node.js
+            - name: Set up Node.js
+              uses: actions/setup-node@v3
+              with:
+                node-version: 18 # Use the version matching your project
+    
+            # Step 3: Install dependencies and build the app
+            - name: Install dependencies and build
+              run: |
+                npm ci
+                npm run build
+    
+            # Step 4: Configure AWS CLI
+            - name: Configure AWS CLI
+              uses: aws-actions/configure-aws-credentials@v2
+              with:
+                aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+                aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+                aws-region: ${{ secrets.AWS_REGION }}
+    
+            # Step 5: Upload to S3
+            - name: Upload to S3
+              run:  aws s3 sync ./apps/docs/build s3://docs.bsamaritan.com --delete

apps/docs/docs/tutorial-extras/_category_.json renamed to apps/docs/docs/deployment/_category_.json

@@ -1,5 +1,5 @@
 {
-  "label": "Tutorial - Extras",
+  "label": "Deployment",
   "position": 3,
   "link": {
     "type": "generated-index"

apps/docs/docs/tutorial-extras/img/docsVersionDropdown.png renamed to apps/docs/docs/deployment/img/docsVersionDropdown.png

@@ -0,0 +1,5 @@
+---
+sidebar_position: 5
+---
+
+# FAQs

apps/docs/docs/tutorial-extras/img/localeDropdown.png renamed to apps/docs/docs/deployment/img/localeDropdown.png

@@ -0,0 +1,8 @@
+{
+  "label": "Getting Credentials",
+  "position": 2,
+  "link": {
+    "type": "generated-index",
+    "description": "Getting API Keys or OAuth Credentials for the third party connections."
+  }
+}

apps/docs/docs/tutorial-extras/manage-docs-versions.md renamed to apps/docs/docs/deployment/manage-docs-versions.md

@@ -0,0 +1,8 @@
+{
+  "label": "Getting Started",
+  "position": 2,
+  "link": {
+    "type": "generated-index",
+    "description": "In this section, we'll guide you through the initial steps to get started with deploying the application locally. Before you dive into the specifics, make sure you meet the system requirements and have everything in place."
+  }
+}

apps/docs/docs/tutorial-extras/translate-your-site.md renamed to apps/docs/docs/deployment/translate-your-site.md

@@ -0,0 +1,63 @@
+---
+sidebar_position: 1
+---
+
+# Requirements
+
+## Public Site
+
+- Any Browser
+
+## Using Locally in Dev Mode
+
+- python >= 3.8 
+  ``` bash
+  # Check Availability and Version
+  python
+  ```
+  Download using this site https://www.python.org/downloads/ 
+  
+- node >= 21.7.3
+  ``` bash
+  # Check Availability and Version
+  node -v
+  ```
+  Download using this site https://docs.npmjs.com/downloading-and-installing-node-js-and-npm
+
+- npm >= 10.5.0
+  ``` bash
+  # Check Availability and Version
+  npm -v
+  ```
+  Download using this site https://docs.npmjs.com/downloading-and-installing-node-js-and-npm
+  
+- git
+  ``` bash
+  # Check Availability
+  git
+  ```
+  Download using this site https://git-scm.com/downloads
+
+## Using Locally using Docker Compose
+
+- docker >= 27.1.1
+  ``` bash
+  # Check Availability and Version
+  docker -v
+  ```
+  Download using this site https://www.docker.com/products/docker-desktop/
+
+
+- docker-compose >= 1.29.2
+  ``` bash
+  # Check Availability and Version
+  docker-compose -v
+  ```
+  Download using this site https://docs.docker.com/compose/install
+
+- git
+  ``` bash
+  # Check Availability
+  git
+  ```
+  Download using this site https://git-scm.com/downloads

apps/docs/docs/faqs.md

@@ -0,0 +1,34 @@
+---
+sidebar_position: 1
+---
+
+# Overview
+
+CASY (Code Automation System) is  a open source semi code automation solution to automate every aspect of your life with sample code generation and public workflows with third party connections like Notion, Open AI, Youtube and Google Drive using the above boilerplate. 
+
+## Key Features
+
+CASY comes with a fully customizable features that cater to a diverse set of users. Here are some of the key features:
+
+* **Automations**: Create Automations by creating series of trigger and actions of multiple code blocks.
+* **Sample Code Generation**: Generate Code Blocks related to third party api calls to Notion, OpenAI, Youtube, Google Drive, etc.
+* **Notion Systems**: Links of Notion Pages which can be duplicated with different Systems to gamify all aspect of your life.
+* **Third Party Connections**: OAuth and API key connections with lot of third party apps.
+
+## Who Should Use This Documentation
+
+This documentation is intended for:
+
+* **New Users**: If you're new to CASY, this guide will help you get started, set up your account, and begin using the application effectively.
+* **Experienced Users**:  If you're already familiar with our application, this documentation serves as a valuable resource for advanced configurations, best practices, and troubleshooting.
+
+## How to Use This Documentation
+
+* **Search**: Use the search bar to quickly find information on specific topics.
+* **Navigation**:The documentation is organized into sections, so you can navigate through the table of contents to locate the information you need.
+* **Links**: We've included links to related articles and resources for in-depth exploration.
+* **Feedback**: If you can't find the information you're looking for or have suggestions for improvement, please let us know.
+
+## Contacting Support
+
+If you encounter any issues or have questions not covered in this documentation, our dedicated support team is here to assist you. Contact us at *[email protected]*.

apps/docs/docs/getting-started/Get Credentials/_category_.json

@@ -0,0 +1,5 @@
+---
+sidebar_position: 4
+---
+
+# Troubleshooting

apps/docs/docs/getting-started/Get Credentials/google-drive.md

@@ -96,7 +96,7 @@ const config: Config = {
           items: [
             {
               label: 'Tutorial',
-              to: '/docs/intro',
+              to: '/docs/overview',
             },
           ],
         },

apps/docs/docs/getting-started/Get Credentials/notion.md

@@ -51,7 +51,7 @@ function Feature({title, path, description}: FeatureItem) {
   return (
     <div className={clsx('col col--4')}>
       <div className="text--center">
-        <img src={path} alt={title} className='w-4 h-4' />
+        <img src={path} alt={title} width="100" height="100"/>
       </div>
       <div className="text--center padding-horiz--md">
         <Heading as="h3">{title}</Heading>

apps/docs/docs/getting-started/Get Credentials/openai.md

@@ -8,6 +8,7 @@
     "format": "prettier --write \"**/*.{ts,tsx,md}\"",
     "db:migrate": "cd packages/prisma-db && npx prisma migrate dev --name init",
     "db:generate": "cd packages/prisma-db && npx prisma generate",
+    "build-docs": "cd ./apps/docs && npm ci && npm run build",
     "build-dashboard-app": "cd ./apps/dashboard-app && npm run build",
     "start-dashboard-app": "cd ./apps/dashboard-app && npm run start",
     "start-scheduler": "cd ./apps/scheduler && npm run dev",