docusaurus conversion

Author: heskew

.github/workflows/deploy.yaml

@@ -54,13 +54,11 @@ jobs:
 
       - name: Build Docusaurus site
         env:
-          DOCS_PATH: ${{ vars.DOCS_PATH }}
           DOCUSAURUS_BASE_URL: ${{ vars.DOCUSAURUS_BASE_URL }}
           DOCUSAURUS_URL: ${{ vars.DOCUSAURUS_URL }}
           IMAGES_PATH: ${{ vars.IMAGES_PATH }}
         run: |
           echo "Building Docusaurus site..."
-          echo "Using DOCS_PATH: $DOCS_PATH"
           echo "Using DOCUSAURUS_BASE_URL: $DOCUSAURUS_BASE_URL"
           echo "Using DOCUSAURUS_URL: $DOCUSAURUS_URL"
           echo "Using IMAGES_PATH: $IMAGES_PATH"

docs/README.md

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

docs/SUMMARY.md

@@ -1,3 +1,7 @@
+---
+title: Best Practices and Recommendations
+---
+
 # Best Practices and Recommendations
 
 Harper is designed for minimal administrative effort, and with managed services these are handled for you. But there are important things to consider for managing your own Harper servers.
@@ -7,22 +11,22 @@ Harper is designed for minimal administrative effort, and with managed services
 As a distributed database, data protection and recovery can benefit from different data protection strategies than a traditional single-server database. But multiple aspects of data protection and recovery should be considered:
 
 - Availability: As a distributed database Harper is intrinsically built for high-availability and a cluster will continue to run even with complete server(s) failure. This is the first and primary defense for protecting against any downtime or data loss. Harper provides fast horizontal scaling functionality with node cloning, which facilitates ease of establishing high availability clusters.
-- [Audit log](logging/audit-logging.md): Harper defaults to tracking data changes so malicious data changes can be found, attributed, and reverted. This provides security-level defense against data loss, allowing for fine-grained isolation and reversion of individual data without the large-scale reversion/loss of data associated with point-in-time recovery approaches.
-- Snapshots: When used as a source-of-truth database for crucial data, we recommend using snapshot tools to regularly snapshot databases as a final backup/defense against data loss (this should only be used as a last resort in recovery). Harper has a [`get_backup`](../developers/operations-api/databases-and-tables.md#get-backup) operation, which provides direct support for making and retrieving database snapshots. An HTTP request can be used to get a snapshot. Alternatively, volume snapshot tools can be used to snapshot data at the OS/VM level. Harper can also provide scripts for replaying transaction logs from snapshots to facilitate point-in-time recovery when necessary (often customization may be preferred in certain recovery situations to minimize data loss).
+- [Audit log](logging/audit-logging): Harper defaults to tracking data changes so malicious data changes can be found, attributed, and reverted. This provides security-level defense against data loss, allowing for fine-grained isolation and reversion of individual data without the large-scale reversion/loss of data associated with point-in-time recovery approaches.
+- Snapshots: When used as a source-of-truth database for crucial data, we recommend using snapshot tools to regularly snapshot databases as a final backup/defense against data loss (this should only be used as a last resort in recovery). Harper has a [`get_backup`](../developers/operations-api/databases-and-tables#get-backup) operation, which provides direct support for making and retrieving database snapshots. An HTTP request can be used to get a snapshot. Alternatively, volume snapshot tools can be used to snapshot data at the OS/VM level. Harper can also provide scripts for replaying transaction logs from snapshots to facilitate point-in-time recovery when necessary (often customization may be preferred in certain recovery situations to minimize data loss).
 
 ### Horizontal Scaling with Node Cloning
 
-Harper provides rapid horizontal scaling capabilities through [node cloning functionality described here](cloning.md).
+Harper provides rapid horizontal scaling capabilities through [node cloning functionality described here](cloning).
 
 ### Monitoring
 
 Harper provides robust capabilities for analytics and observability to facilitate effective and informative monitoring:
 
-- Analytics provides statistics on usage, request counts, load, memory usage with historical tracking. The analytics data can be [accessed through querying](../technical-details/reference/analytics.md).
-- A large variety of real-time statistics about load, system information, database metrics, thread usage can be retrieved through the [`system_information` API](../developers/operations-api/system-operations.md).
-- Information about the current cluster configuration and status can be found in the [cluster APIs](../developers/operations-api/clustering.md).
-- Analytics and system information can easily be exported to Prometheus with our [Prometheus exporter component](https://github.com/HarperDB-Add-Ons/prometheus_exporter), making it easy visualize and monitor Harper with Graphana.
+- Analytics provides statistics on usage, request counts, load, memory usage with historical tracking. The analytics data can be [accessed through querying](../technical-details/reference/analytics).
+- A large variety of real-time statistics about load, system information, database metrics, thread usage can be retrieved through the [`system_information` API](../developers/operations-api/system-operations).
+- Information about the current cluster configuration and status can be found in the [cluster APIs](../developers/operations-api/clustering).
+- Analytics and system information can easily be exported to Prometheus with our [Prometheus exporter component](https:/github.com/HarperDB-Add-Ons/prometheus_exporter), making it easy visualize and monitor Harper with Graphana.
 
 ### Replication Transaction Logging
 
-Harper utilizes NATS for replication, which maintains a transaction log. See the [transaction log documentation for information on how to query this log](logging/transaction-logging.md).
+Harper utilizes NATS for replication, which maintains a transaction log. See the [transaction log documentation for information on how to query this log](logging/transaction-logging).

docs/administration/_category_.json

@@ -1,3 +1,7 @@
+---
+title: Clone Node
+---
+
 # Clone Node
 
 Clone node is a configurable node script that when pointed to another instance of Harper will create a clone of that
@@ -22,7 +26,7 @@ To start clone run `harperdb` in the CLI with either of the following variables
 For example:
 
 ```
-HDB_LEADER_URL=https://node-1.my-domain.com:9925 REPLICATION_HOSTNAME=node-1.my-domain.com HDB_LEADER_USERNAME=... HDB_LEADER_PASSWORD=... harperdb
+HDB_LEADER_URL=https:/node-1.my-domain.com:9925 REPLICATION_HOSTNAME=node-1.my-domain.com HDB_LEADER_USERNAME=... HDB_LEADER_PASSWORD=... harperdb
 ```
 
 #### Command line variables
@@ -35,7 +39,7 @@ HDB_LEADER_URL=https://node-1.my-domain.com:9925 REPLICATION_HOSTNAME=node-1.my-
 For example:
 
 ```
-harperdb --HDB_LEADER_URL https://node-1.my-domain.com:9925 --REPLICATION_HOSTNAME node-1.my-domain.com --HDB_LEADER_USERNAME ... --HDB_LEADER_PASSWORD ...
+harperdb --HDB_LEADER_URL https:/node-1.my-domain.com:9925 --REPLICATION_HOSTNAME node-1.my-domain.com --HDB_LEADER_USERNAME ... --HDB_LEADER_PASSWORD ...
 ```
 
 Each time clone is run it will set a value `cloned: true` in `harperdb-config.yaml`. This value will prevent clone from
@@ -46,7 +50,7 @@ Clone node does not require any additional configuration apart from the variable
 However, if you wish to set any configuration during clone this can be done by passing the config as environment/CLI
 variables or cloning overtop of an existing `harperdb-config.yaml` file.
 
-More can be found in the Harper config documentation [here](../deployments/configuration.md).
+More can be found in the Harper config documentation [here](../deployments/configuration).
 
 ### Excluding database and components
 
@@ -121,12 +125,12 @@ leader and the clone.
 Clone node will execute the following steps when ran:
 
 1. Look for an existing Harper install. It does this by using the default (or user provided) `ROOTPATH`.
-2. If an existing instance is found it will check for a `harperdb-config.yaml` file and search for the `cloned` value. If the value exists and is `true` clone will skip the clone logic and start Harper.
-3. Clone harperdb-config.yaml values that don't already exist (excluding values unique to the leader node).
-4. Fully clone any databases that don't already exist.
-5. If classed as a "fresh clone", install Harper. An instance is classed as a fresh clone if there is no system database.
-6. If `REPLICATION_HOSTNAME` is set, set up replication between the leader and clone.
-7. Clone is complete, start Harper.
+1. If an existing instance is found it will check for a `harperdb-config.yaml` file and search for the `cloned` value. If the value exists and is `true` clone will skip the clone logic and start Harper.
+1. Clone harperdb-config.yaml values that don't already exist (excluding values unique to the leader node).
+1. Fully clone any databases that don't already exist.
+1. If classed as a "fresh clone", install Harper. An instance is classed as a fresh clone if there is no system database.
+1. If `REPLICATION_HOSTNAME` is set, set up replication between the leader and clone.
+1. Clone is complete, start Harper.
 
 ### Cloning with Docker
 
@@ -139,7 +143,7 @@ docker run -d \
   -v <host directory>:/home/harperdb/hdb \
   -e HDB_LEADER_PASSWORD=password \
   -e HDB_LEADER_USERNAME=admin \
-  -e HDB_LEADER_URL=https://1.123.45.6:9925 \
+  -e HDB_LEADER_URL=https:/1.123.45.6:9925 \
   -e REPLICATION_HOSTNAME=1.123.45.6 \
   -p 9925:9925 \
   -p 9926:9926 \

docs/administration/administration.md

@@ -1,3 +1,7 @@
+---
+title: Compact
+---
+
 # Compact
 
 Database files can grow quickly as you use them, sometimes impeding performance. Harper has multiple compact features that can be used to reduce database file size and potentially improve performance. The compact process does not compress your data, it instead makes your database file smaller by eliminating free-space and fragmentation.
@@ -6,15 +10,15 @@ There are two options that Harper offers for compacting a Database.
 
 _Note: Some of the storage configuration (such as compression) cannot be updated on existing databases, this is where the following options are useful. They will create a new compressed copy of the database with any updated configuration._
 
-More information on the storage configuration options can be [found here](../deployments/configuration.md#storage)
+More information on the storage configuration options can be [found here](../deployments/configuration#storage)
 
 ### Copy compaction
 
 It is recommended that, to prevent any record loss, Harper is not running when performing this operation.
 
 This will copy a Harper database with compaction. If you wish to use this new database in place of the original, you will need to move/rename it to the path of the original database.
 
-This command should be run in the [CLI](../deployments/harper-cli.md)
+This command should be run in the [CLI](../deployments/harper-cli)
 
 ```bash
 harperdb copy-db <source-database> <target-database-path>

docs/administration/cloning.md

@@ -1,22 +1,26 @@
+---
+title: Create a Studio Account
+---
+
 # Create a Studio Account
 
-Start at the [Harper Studio sign up page](https://studio.harperdb.io/sign-up).
+Start at the [Harper Studio sign up page](https:/studio.harperdb.io/sign-up).
 
 1. Provide the following information:
    - First Name
    - Last Name
    - Email Address
    - Subdomain
 
-     _Part of the URL that will be used to identify your Harper Cloud Instances. For example, with subdomain “demo” and instance name “c1” the instance URL would be: https://c1-demo.harperdbcloud.com._
+     _Part of the URL that will be used to identify your Harper Cloud Instances. For example, with subdomain “demo” and instance name “c1” the instance URL would be: https:/c1-demo.harperdbcloud.com._
 
    - Coupon Code (optional)
 
-2. Review the Privacy Policy and Terms of Service.
-3. Click the sign up for free button.
-4. You will be taken to a new screen to add an account password. Enter your password.
+1. Review the Privacy Policy and Terms of Service.
+1. Click the sign up for free button.
+1. You will be taken to a new screen to add an account password. Enter your password.
    _Passwords must be a minimum of 8 characters with at least 1 lower case character, 1 upper case character, 1 number, and 1 special character._
-5. Click the add account password button.
+1. Click the add account password button.
 
 You will receive a Studio welcome email confirming your registration.
 

docs/administration/compact.md

@@ -1,5 +1,9 @@
+---
+title: Enable Mixed Content
+---
+
 # Enable Mixed Content
 
 Enabling mixed content is required in cases where you would like to connect the Harper Studio to Harper Instances via HTTP. This should not be used for production systems, but may be convenient for development and testing purposes. Doing so will allow your browser to reach HTTP traffic, which is considered insecure, through an HTTPS site like the Studio.
 
-A comprehensive guide is provided by Adobe [here](https://experienceleague.adobe.com/docs/target/using/experiences/vec/troubleshoot-composer/mixed-content.html).
+A comprehensive guide is provided by Adobe [here](https:/experienceleague.adobe.com/docs/target/using/experiences/vec/troubleshoot-composer/mixed-content.html).