chore: update docs and adds screenshots

Author: gabrielcsapo

generate-docs.js

@@ -1,20 +1,21 @@
 /**
  * Requires jsdoc and jsdoc-to-markdown
  */
- 
+
 /* eslint-disable no-console */
-const fs = require('fs')
-const path = require('path')
-const glob = require('glob')
-const { execSync } = require('child_process');
+import fs from 'fs';
+
+import path from 'path';
+import glob from 'glob';
+import { execSync } from 'child_process';
 
 /**
  * Runs through packages folders looking for JSDoc and generates markdown docs
  */
 function generateDocs() {
   console.log('Generating package docs')
   // Use glob to get all js/ts files
-  const pathPattern = path.join(__dirname, './lib/**/*.[jt]s?(x)')
+  const pathPattern = path.join(process.cwd(), './lib/**/*.[jt]s?(x)')
   const filePaths = glob.sync(pathPattern, {
     ignore: [
       '**/node_modules/**',
@@ -25,16 +26,14 @@ function generateDocs() {
     ],
   })
 
-  console.log(filePaths)
-
   for(const file of filePaths) {
     const { base: fileName } = path.parse(file);
 
     const relativePath = path.relative(process.cwd(), file);
     const markdown = execSync(`./node_modules/.bin/jsdoc2md ${relativePath}`);
 
     const writeDir = path.join(
-      __dirname,
+      process.cwd(),
       `website/docs/api/${relativePath.replace(fileName, '')}`,
     )
 

package.json

@@ -60,7 +60,7 @@
     "eslint": "^8.11.0",
     "eslint-plugin-jest": "^26.1.1",
     "jest": "^27.5.1",
-    "jsdoc": "^3.5.4",
+    "jsdoc": "^3.6.10",
     "jsdoc-to-markdown": "^7.1.1",
     "pkg": "^5.5.2"
   },

website/docs/api/_category_.yml

@@ -0,0 +1 @@
+label: API

website/docs/api/lib/helpers/util.js.md

@@ -4,18 +4,18 @@
 
 * [lib/helpers/util](#module_lib/helpers/util)
     * _static_
-        * [.mk(directory)](#module_lib/helpers/util.mk) ⇒ <code>Promise</code>
+        * [.mk](#module_lib/helpers/util.mk) ⇒ <code>Promise</code>
     * _inner_
         * [~getPort()](#module_lib/helpers/util..getPort) ⇒ <code>Promise</code>
         * [~hash(length)](#module_lib/helpers/util..hash) ⇒ <code>String</code>
         * [~contains(arr, contains)](#module_lib/helpers/util..contains) ⇒ <code>Boolean</code>
 
 <a name="module_lib/helpers/util.mk"></a>
 
-### lib/helpers/util.mk(directory) ⇒ <code>Promise</code>
+### lib/helpers/util.mk ⇒ <code>Promise</code>
 makes a directory recursively
 
-**Kind**: static method of [<code>lib/helpers/util</code>](#module_lib/helpers/util)  
+**Kind**: static constant of [<code>lib/helpers/util</code>](#module_lib/helpers/util)  
 
 | Param | Type | Description |
 | --- | --- | --- |

website/docs/intro.md

@@ -1,47 +1,57 @@
 ---
 sidebar_position: 1
+title: "Intro"
 ---
 
-# Tutorial Intro
-
-Let's discover **Docusaurus in less than 5 minutes**.
-
 ## Getting Started
 
-Get started by **creating a new site**.
+Firstly we must install `deploy.sh`.
 
-Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
+```bash
+npm install deploy.sh -g
+```
 
 ### What you'll need
 
 - [Node.js](https://nodejs.org/en/download/) version 14 or above:
   - When installing Node.js, you are recommended to check all checkboxes related to dependencies.
+- [Docker](https://docs.docker.com/get-docker/) is how deploy.sh runs and is required to start new applications
+- [Mongo](https://docs.mongodb.com/manual/administration/install-community/) is required to store application state and logs
 
-## Generate a new site
+## Starting deploy.sh server
 
-Generate a new Docusaurus site using the **classic template**.
+In order to deploy your applications you will need to spin up a deploy.sh server
 
-The classic template will automatically be added to your project after you run the command:
+```bash
+deploy server
+```
 
 ```bash
-npm init docusaurus@latest my-website classic
+% deploy serve
+✔ Started 0 deployment(s) successfully
+⛅️ deploy.sh is running on port 5000
 ```
 
-You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.
+## Start your site
 
-The command also installs all necessary dependencies you need to run Docusaurus.
+In order to do anything you must first go through the registration process by running:
 
-## Start your site
+```
+deploy register
+```
 
-Run the development server:
+For this example I am going to use the folder in `examples/docker` in <https://github.com/gabrielcsapo/deploy.sh>.
 
 ```bash
-cd my-website
-npm run start
+deploy
 ```
 
-The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.
+![../static/img/intro/deploy.png](../static/img/intro/deploy.png)
 
-The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.
+To look at the logs from the docker container itself, simply run `deploy logs`
+
+```bash
+deploy logs
+```
 
-Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.
+![../static/img/intro/logs.png](../static/img/intro/logs.png)

website/docusaurus.config.js

@@ -9,7 +9,7 @@ const config = {
   title: 'deploy.sh',
   tagline: 'an open source continuous deployment service; deploying to the ☁️ shouldn\'t be 🚀🔬',
   url: 'https://gabrielcsapo.github.io',
-  baseUrl: '/',
+  baseUrl: '/gabrielcsapo/deploy.sh/',
   onBrokenLinks: 'throw',
   onBrokenMarkdownLinks: 'warn',
   favicon: 'img/favicon.ico',
@@ -19,7 +19,8 @@ const config = {
     [
       require.resolve("docusaurus-plugin-search-local"),
       {}
-    ]
+    ],
+    require.resolve('docusaurus-plugin-image-zoom')
   ],
   presets: [
     [
@@ -47,6 +48,7 @@ const config = {
   themeConfig:
     /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
     ({
+      zoom: {},
       navbar: {
         title: 'deploy.sh',
         logo: {

website/package.json

@@ -30,6 +30,7 @@
     "@docusaurus/preset-classic": "2.0.0-beta.17",
     "@mdx-js/react": "^1.6.22",
     "clsx": "^1.1.1",
+    "docusaurus-plugin-image-zoom": "^0.0.2",
     "docusaurus-plugin-search-local": "^0.4.0",
     "prism-react-renderer": "^1.2.1",
     "react": "^17.0.1",