Merge pull request #230 from HarperDB/format-2

Format

Author: Ethan-Arrowood

.git-blame-ignore-revs

@@ -1,2 +1,5 @@
 # Initial format commit
-245bc11c93fcff5cbaceddb799de5e1fad132d3e
+245bc11c93fcff5cbaceddb799de5e1fad132d3e
+
+# Replatform format commit
+abe8637ab83416cd9927e5e5e1c121144fbc3969

.github/workflows/deploy.yaml

@@ -13,7 +13,7 @@ on:
 # However, do NOT cancel in-progress runs as we want to allow these deployments to complete.
 # This shouldn't be necessary for most cases, but it can help avoid conflicts if multiple pushes happen in quick succession.
 concurrency:
-  group: "pages"
+  group: 'pages'
   cancel-in-progress: false
 
 jobs:
@@ -93,7 +93,6 @@ jobs:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
 
-
     steps:
       - name: Deploy to GitHub Pages
         id: deployment

.gitignore

@@ -22,4 +22,29 @@ bin-release/
 .idea/modules.xml
 .idea/vcs.xml
 
-node_modules
+node_modules
+
+# Site .gitignore so its picked up by prettier
+# Dependencies
+site/node_modules
+
+# Production
+site/build
+
+# Latest (/docs/) is a build time copy of the latest version
+site/docs
+
+# Generated files
+site/.docusaurus
+site/.cache-loader
+
+# Misc
+site/.DS_Store
+site/.env.local
+site/.env.development.local
+site/.env.test.local
+site/.env.production.local
+
+site/npm-debug.log*
+site/yarn-debug.log*
+site/yarn-error.log*

docs/administration/_category_.json

@@ -1,12 +1,10 @@
 {
-  "label": "Administration",
-  "position": 2,
-  "link": {
-    "type": "generated-index",
-    "title": "Administration Documentation",
-    "description": "Guides for managing and administering HarperDB instances",
-    "keywords": [
-      "administration"
-    ]
-  }
-}
+	"label": "Administration",
+	"position": 2,
+	"link": {
+		"type": "generated-index",
+		"title": "Administration Documentation",
+		"description": "Guides for managing and administering HarperDB instances",
+		"keywords": ["administration"]
+	}
+}

docs/administration/harper-studio/instances.md

@@ -40,11 +40,11 @@ A summary view of all instances within an organization can be viewed by clicking
    1. Select Instance Specs
       1. Select Instance RAM
 
-         _Harper Cloud Instances are billed based on Instance RAM, this will select the size of your provisioned instance._ _More on instance specs__._
+         _Harper Cloud Instances are billed based on Instance RAM, this will select the size of your provisioned instance._ _More on instance specs\_\_._
 
       1. Select Storage Size
 
-         _Each instance has a mounted storage volume where your Harper data will reside. Storage is provisioned based on space and IOPS._ _More on IOPS Impact on Performance__._
+         _Each instance has a mounted storage volume where your Harper data will reside. Storage is provisioned based on space and IOPS._ _More on IOPS Impact on Performance\_\_._
 
       1. Select Instance Region
 

docs/custom-functions/create-project.md

@@ -10,7 +10,7 @@ Otherwise, to create a project, you have the following options:
 
 1. **Use the add_custom_function_project operation**
 
-    This operation creates a new project folder, and populates it with templates for the routes, helpers, and static subfolders.
+   This operation creates a new project folder, and populates it with templates for the routes, helpers, and static subfolders.
 
 ```json
 {

docs/deployments/_category_.json

@@ -1,12 +1,10 @@
 {
-  "label": "Deployments",
-  "position": 3,
-  "link": {
-    "type": "generated-index",
-    "title": "Deployments Documentation",
-    "description": "Installation and deployment guides for HarperDB",
-    "keywords": [
-      "deployments"
-    ]
-  }
-}
+	"label": "Deployments",
+	"position": 3,
+	"link": {
+		"type": "generated-index",
+		"title": "Deployments Documentation",
+		"description": "Installation and deployment guides for HarperDB",
+		"keywords": ["deployments"]
+	}
+}

docs/deployments/configuration.md

@@ -583,9 +583,9 @@ To access the audit logs, use the API operation `read_audit_log`. It will provid
 
 ```json
 {
- "operation": "read_audit_log",
- "schema": "dev",
- "table": "dog"
+	"operation": "read_audit_log",
+	"schema": "dev",
+	"table": "dog"
 }
 ```
 
@@ -728,7 +728,7 @@ This section defines log configuration for HTTP logging. By default, HTTP reques
 - `timing` - This will log timing information
 - `headers` - This will log the headers in each request (which can be very verbose)
 - `id` - This will assign a unique id to each request and log it in the entry for each request. This is assigned as the `request.requestId` property and can be used to by other logging to track a request.
-Note that the `level` will determine which HTTP requests are logged:
+  Note that the `level` will determine which HTTP requests are logged:
 - `info` (or more verbose) - All HTTP requests
 - `warn` - HTTP requests with a status code of 400 or above
 - `error` - HTTP requests with a status code of 500
@@ -737,10 +737,10 @@ For example:
 
 ```yaml
 http:
-  logging: 
+  logging:
     timing: true
     level: info
-    path: ~/hdb/log/http.log 
+    path: ~/hdb/log/http.log
   ... rest of http config
 ```
 

docs/deployments/harper-cloud/alarms.md

@@ -13,8 +13,8 @@ Harper Cloud instance alarms are triggered when certain conditions are met. Once
 - **Intervals**: The number of occurrences before an alarm is triggered and the period that the metric is evaluated over.
 - **Proposed Remedy**: Recommended solution to avoid the alert in the future.
 
-| Alarm   | Threshold  | Intervals | Proposed Remedy                                                                                                                |
-| ------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------ |
+| Alarm   | Threshold  | Intervals | Proposed Remedy                                                                                                             |
+| ------- | ---------- | --------- | --------------------------------------------------------------------------------------------------------------------------- |
 | Storage | > 90% Disk | 1 x 5min  | [Increased storage volume](../../administration/harper-studio/instance-configuration#update-instance-storage)               |
 | CPU     | > 90% Avg  | 2 x 5min  | [Increase instance size for additional CPUs](../../administration/harper-studio/instance-configuration#update-instance-ram) |
 | Memory  | > 90% RAM  | 2 x 5min  | [Increase instance size](../../administration/harper-studio/instance-configuration#update-instance-ram)                     |

docs/deployments/upgrade-hdb-instance.md

@@ -12,11 +12,11 @@ Upgrading Harper is a two-step process. First the latest version of Harper must
 
 1. Install the latest version of Harper using `npm install -g harperdb`.
 
-    Note `-g` should only be used if you installed Harper globally (which is recommended).
+   Note `-g` should only be used if you installed Harper globally (which is recommended).
 
 1. Run `harperdb` to initiate the upgrade process.
 
-    Harper will then prompt you for all appropriate inputs and then run the upgrade directives.
+   Harper will then prompt you for all appropriate inputs and then run the upgrade directives.
 
 ## Node Version Manager (nvm)
 
@@ -130,7 +130,7 @@ replication:
 {
 	"operation": "add_node",
 	"hostname:": "node-1",
- "url": "wss://my-cluster-node-1:9925"
+	"url": "wss://my-cluster-node-1:9925"
 }
 ```