Skip to content

Commit 32a6d27

Browse files
authored
Merge pull request #226 from HarperDB/little-cleanup
Little cleanup
2 parents 880528c + f3c0421 commit 32a6d27

File tree

476 files changed

+2400
-2208
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

476 files changed

+2400
-2208
lines changed

.github/workflows/deploy.yaml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ on:
66
push:
77
branches:
88
- main
9-
- docs-in-hdb
109
# Allows you to run this workflow manually from the Actions tab
1110
workflow_dispatch:
1211

@@ -83,8 +82,8 @@ jobs:
8382
needs: build
8483
name: Deploy to GitHub Pages
8584
runs-on: ubuntu-latest
86-
# Only deploy on push to specific branches, not on PRs
87-
if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/docs-in-hdb')
85+
# Only deploy on push to main or manual trigger, not on PRs
86+
if: (github.event_name == 'push' && github.ref == 'refs/heads/main') || github.event_name == 'workflow_dispatch'
8887

8988
permissions:
9089
pages: write

docs/administration/administration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Harper provides robust capabilities for analytics and observability to facilitat
2525
- 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).
2626
- 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).
2727
- Information about the current cluster configuration and status can be found in the [cluster APIs](../developers/operations-api/clustering).
28-
- 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.
28+
- 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.
2929

3030
### Replication Transaction Logging
3131

docs/administration/cloning.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ To start clone run `harperdb` in the CLI with either of the following variables
2626
For example:
2727

2828
```
29-
HDB_LEADER_URL=https:/node-1.my-domain.com:9925 REPLICATION_HOSTNAME=node-1.my-domain.com HDB_LEADER_USERNAME=... HDB_LEADER_PASSWORD=... harperdb
29+
HDB_LEADER_URL=https://node-1.my-domain.com:9925 REPLICATION_HOSTNAME=node-1.my-domain.com HDB_LEADER_USERNAME=... HDB_LEADER_PASSWORD=... harperdb
3030
```
3131

3232
#### Command line variables
@@ -39,7 +39,7 @@ HDB_LEADER_URL=https:/node-1.my-domain.com:9925 REPLICATION_HOSTNAME=node-1.my-d
3939
For example:
4040

4141
```
42-
harperdb --HDB_LEADER_URL https:/node-1.my-domain.com:9925 --REPLICATION_HOSTNAME node-1.my-domain.com --HDB_LEADER_USERNAME ... --HDB_LEADER_PASSWORD ...
42+
harperdb --HDB_LEADER_URL https://node-1.my-domain.com:9925 --REPLICATION_HOSTNAME node-1.my-domain.com --HDB_LEADER_USERNAME ... --HDB_LEADER_PASSWORD ...
4343
```
4444

4545
Each time clone is run it will set a value `cloned: true` in `harperdb-config.yaml`. This value will prevent clone from
@@ -143,7 +143,7 @@ docker run -d \
143143
-v <host directory>:/home/harperdb/hdb \
144144
-e HDB_LEADER_PASSWORD=password \
145145
-e HDB_LEADER_USERNAME=admin \
146-
-e HDB_LEADER_URL=https:/1.123.45.6:9925 \
146+
-e HDB_LEADER_URL=https://1.123.45.6:9925 \
147147
-e REPLICATION_HOSTNAME=1.123.45.6 \
148148
-p 9925:9925 \
149149
-p 9926:9926 \

docs/administration/harper-studio/create-account.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ title: Create a Studio Account
44

55
# Create a Studio Account
66

7-
Start at the [Harper Studio sign up page](https:/studio.harperdb.io/sign-up).
7+
Start at the [Harper Studio sign up page](https://studio.harperdb.io/sign-up).
88

99
1. Provide the following information:
1010
- First Name
1111
- Last Name
1212
- Email Address
1313
- Subdomain
1414

15-
_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._
15+
_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](https://c1-demo.harperdbcloud.com)._
1616

1717
- Coupon Code (optional)
1818

docs/administration/harper-studio/enable-mixed-content.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ title: Enable Mixed Content
66

77
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.
88

9-
A comprehensive guide is provided by Adobe [here](https:/experienceleague.adobe.com/docs/target/using/experiences/vec/troubleshoot-composer/mixed-content.html).
9+
A comprehensive guide is provided by Adobe [here](https://experienceleague.adobe.com/docs/target/using/experiences/vec/troubleshoot-composer/mixed-content.html).

docs/administration/harper-studio/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ title: Harper Studio
66

77
Harper Studio is the web-based GUI for Harper. Studio enables you to administer, navigate, and monitor all of your Harper instances in a simple, user-friendly interface without any knowledge of the underlying Harper API. It’s free to sign up, get started today!
88

9-
[Sign up for free!](https:/studio.harperdb.io/sign-up)
9+
[Sign up for free!](https://studio.harperdb.io/sign-up)
1010

11-
Harper now includes a simplified local Studio that is packaged with all Harper installations and served directly from the instance. It can be enabled in the [configuration file](../../deployments/configuration#localstudio). This section is dedicated to the hosted Studio accessed at [studio.harperdb.io](https:/studio.harperdb.io).
11+
Harper now includes a simplified local Studio that is packaged with all Harper installations and served directly from the instance. It can be enabled in the [configuration file](../../deployments/configuration#localstudio). This section is dedicated to the hosted Studio accessed at [studio.harperdb.io](https://studio.harperdb.io).
1212

1313
---
1414

docs/administration/harper-studio/instance-configuration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Harper instance configuration can be viewed and managed directly through the Har
88

99
All instance configuration is handled through the **config** page of the Harper Studio, accessed with the following instructions:
1010

11-
1. Navigate to the [Harper Studio Organizations](https:/studio.harperdb.io/organizations) page.
11+
1. Navigate to the [Harper Studio Organizations](https://studio.harperdb.io/organizations) page.
1212

1313
1. Click the appropriate organization that the instance belongs to.
1414

@@ -62,7 +62,7 @@ Note: For Harper Cloud instances, upgrading RAM may add additional CPUs to your
6262

6363
1. Once your instance upgrade is complete, it will appear on the instance dashboard as status OK with your newly selected instance size.
6464

65-
_Note, if Harper Cloud instance reprovisioning takes longer than 20 minutes, please submit a support ticket here: https:/harperdbhelp.zendesk.com/hc/en-us/requests/new._
65+
_Note, if Harper Cloud instance reprovisioning takes longer than 20 minutes, please submit a support ticket here: [https://harperdbhelp.zendesk.com/hc/en-us/requests/new](https://harperdbhelp.zendesk.com/hc/en-us/requests/new)._
6666

6767
## Update Instance Storage
6868

@@ -79,7 +79,7 @@ Note: Instance storage can only be upgraded once every 6 hours.
7979
1. The instance will shut down and begin reprovisioning itself. The instance will not be available during this time. You will be returned to the instance dashboard and the instance status will show UPDATING INSTANCE.
8080
1. Once your instance upgrade is complete, it will appear on the instance dashboard as status OK with your newly selected instance size.
8181

82-
_Note, if this process takes longer than 20 minutes, please submit a support ticket here: https:/harperdbhelp.zendesk.com/hc/en-us/requests/new._
82+
_Note, if this process takes longer than 20 minutes, please submit a support ticket here: [https://harperdbhelp.zendesk.com/hc/en-us/requests/new](https://harperdbhelp.zendesk.com/hc/en-us/requests/new)._
8383

8484
## Remove Instance
8585

docs/administration/harper-studio/instance-metrics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: Instance Metrics
66

77
The Harper Studio display instance status and metrics on the instance status page, which can be accessed with the following instructions:
88

9-
1. Navigate to the [Harper Studio Organizations](https:/studio.harperdb.io/organizations) page.
9+
1. Navigate to the [Harper Studio Organizations](https://studio.harperdb.io/organizations) page.
1010
1. Click the appropriate organization that the instance belongs to.
1111
1. Select your desired instance.
1212
1. Click **status** in the instance control bar.

docs/administration/harper-studio/instances.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,19 @@ All interactions between the Studio and your instances take place directly from
1414

1515
## Organization Instance List
1616

17-
A summary view of all instances within an organization can be viewed by clicking on the appropriate organization from the [Harper Studio Organizations](https:/studio.harperdb.io/organizations) page. Each instance gets their own card. Harper Cloud and Enterprise instances are listed together.
17+
A summary view of all instances within an organization can be viewed by clicking on the appropriate organization from the [Harper Studio Organizations](https://studio.harperdb.io/organizations) page. Each instance gets their own card. Harper Cloud and Enterprise instances are listed together.
1818

1919
## Create a New Instance
2020

21-
1. Navigate to the [Harper Studio Organizations](https:/studio.harperdb.io/organizations) page.
21+
1. Navigate to the [Harper Studio Organizations](https://studio.harperdb.io/organizations) page.
2222
1. Click the appropriate organization for the instance to be created under.
2323
1. Click the **Create New Harper Cloud Instance + Register Enterprise Instance** card.
2424
1. Select your desired Instance Type.
2525
1. For a Harper Cloud Instance or a Harper 5G Wavelength Instance, click **Create Harper Cloud Instance**.
2626
1. Fill out Instance Info.
2727
1. Enter Instance Name
2828

29-
_This will be used to build your instance URL. For example, with subdomain “demo” and instance name “c1” the instance URL would be: https:/c1-demo.harperdbcloud.com. The Instance URL will be previewed below._
29+
_This will be used to build your instance URL. For example, with subdomain “demo” and instance name “c1” the instance URL would be: [https://c1-demo.harperdbcloud.com](https://c1-demo.harperdbcloud.com). The Instance URL will be previewed below._
3030

3131
1. Enter Instance Username
3232

@@ -52,13 +52,13 @@ A summary view of all instances within an organization can be viewed by clicking
5252

5353
1. Click **Confirm Instance Details** to move to the next page.
5454
1. Review your Instance Details, if there is an error, use the back button to correct it.
55-
1. Review the [Privacy Policy](https:/harperdb.io/legal/privacy-policy/) and [Terms of Service](https:/harperdb.io/legal/harperdb-cloud-terms-of-service/), if you agree, click the **I agree** radio button to confirm.
55+
1. Review the [Privacy Policy](https://harperdb.io/legal/privacy-policy/) and [Terms of Service](https://harperdb.io/legal/harperdb-cloud-terms-of-service/), if you agree, click the **I agree** radio button to confirm.
5656
1. Click **Add Instance**.
5757
1. Your Harper Cloud instance will be provisioned in the background. Provisioning typically takes 5-15 minutes. You will receive an email notification when your instance is ready.
5858

5959
## Register Enterprise Instance
6060

61-
1. Navigate to the [Harper Studio Organizations](https:/studio.harperdb.io/organizations) page.
61+
1. Navigate to the [Harper Studio Organizations](https://studio.harperdb.io/organizations) page.
6262
1. Click the appropriate organization for the instance to be created under.
6363
1. Click the **Create New Harper Cloud Instance + Register Enterprise Instance** card.
6464
1. Select **Register Enterprise Instance**.
@@ -95,7 +95,7 @@ A summary view of all instances within an organization can be viewed by clicking
9595

9696
1. Click **Confirm Instance Details** to move to the next page.
9797
1. Review your Instance Details, if there is an error, use the back button to correct it.
98-
1. Review the [Privacy Policy](https:/harperdb.io/legal/privacy-policy/) and [Terms of Service](https:/harperdb.io/legal/harperdb-cloud-terms-of-service/), if you agree, click the **I agree** radio button to confirm.
98+
1. Review the [Privacy Policy](https://harperdb.io/legal/privacy-policy/) and [Terms of Service](https://harperdb.io/legal/harperdb-cloud-terms-of-service/), if you agree, click the **I agree** radio button to confirm.
9999
1. Click **Add Instance**.
100100
1. The Harper Studio will register your instance and restart it for the registration to take effect. Your instance will be immediately available after this is complete.
101101

@@ -108,7 +108,7 @@ Instance deletion has two different behaviors depending on the instance type.
108108

109109
An instance can be deleted as follows:
110110

111-
1. Navigate to the [Harper Studio Organizations](https:/studio.harperdb.io/organizations) page.
111+
1. Navigate to the [Harper Studio Organizations](https://studio.harperdb.io/organizations) page.
112112
1. Click the appropriate organization that the instance belongs to.
113113
1. Identify the proper instance card and click the trash can icon.
114114
1. Enter the instance name into the text box.
@@ -125,14 +125,14 @@ Harper instances can be resized on the [Instance Configuration](instance-configu
125125

126126
The Studio enables users to log in and out of different database users from the instance control panel. To log out of an instance:
127127

128-
1. Navigate to the [Harper Studio Organizations](https:/studio.harperdb.io/organizations) page.
128+
1. Navigate to the [Harper Studio Organizations](https://studio.harperdb.io/organizations) page.
129129
1. Click the appropriate organization that the instance belongs to.
130130
1. Identify the proper instance card and click the lock icon.
131131
1. You will immediately be logged out of the instance.
132132

133133
To log in to an instance:
134134

135-
1. Navigate to the [Harper Studio Organizations](https:/studio.harperdb.io/organizations) page.
135+
1. Navigate to the [Harper Studio Organizations](https://studio.harperdb.io/organizations) page.
136136
1. Click the appropriate organization that the instance belongs to.
137137
1. Identify the proper instance card, it will have an unlocked icon and a status reading PLEASE LOG IN, and click the center of the card.
138138
1. Enter the database username.

docs/administration/harper-studio/login-password-reset.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ title: Login and Password Reset
88

99
To log into your existing Harper Studio account:
1010

11-
1. Navigate to the [Harper Studio](https:/studio.harperdb.io/).
11+
1. Navigate to the [Harper Studio](https://studio.harperdb.io/).
1212
1. Enter your email address.
1313
1. Enter your password.
1414
1. Click **sign in**.

0 commit comments

Comments
 (0)