Skip to content

Commit 5a5e07c

Browse files
authored
Merge pull request #359 from HarperFast/heskew/cleanup
minor docs cleanup
2 parents b691956 + 5426d1a commit 5a5e07c

File tree

25 files changed

+54
-31
lines changed

25 files changed

+54
-31
lines changed

docs/developers/operations-api/advanced-json-sql-examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: Advanced JSON SQL Examples
66

77
## Create movies database
88

9-
Create a new database called "movies" using the 'create_database' operation.
9+
Create a new database called `movies` using the `create_database` operation.
1010

1111
_Note: Creating a database is optional, if one is not created Harper will default to using a database named `data`_
1212

docs/developers/operations-api/clustering.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Clustering
44

55
# Clustering
66

7-
The following operations are available for configuring and managing [Harper replication](../replication/).\
7+
The following operations are available for configuring and managing [Harper replication](../replication/).
88

99
_**If you are using NATS for clustering, please see the**_ [_**NATS Clustering Operations**_](clustering-nats) _**documentation.**_
1010

docs/developers/operations-api/components.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -529,7 +529,10 @@ _Operation is restricted to super_user roles only_
529529

530530
## Install Node Modules
531531

532-
This operation is deprecated, as it is handled automatically by deploy_component and restart.
532+
:::warning Deprecated
533+
This operation is deprecated, as it is handled automatically by [deploy_component](#deploy-component) and [restart](./system-operations#restart).
534+
:::
535+
533536
Executes npm install against specified custom function projects.
534537

535538
_Operation is restricted to super_user roles only_

docs/developers/operations-api/configuration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ title: Configuration
66

77
## Set Configuration
88

9-
Modifies the Harper configuration file parameters. Must follow with a restart or restart_service operation.
9+
Modifies the Harper configuration file parameters. Must follow with a [restart](./system-operations#restart) or [restart_service](./system-operations#restart-service) operation.
1010

1111
_Operation is restricted to super_user roles only_
1212

1313
- `operation` _(required)_ - must always be `set_configuration`
14-
- `logging_level` _(example/optional)_ - one or more configuration keywords to be updated in the Harper configuration file
15-
- `clustering_enabled` _(example/optional)_ - one or more configuration keywords to be updated in the Harper configuration file
14+
- `logging_level` _(optional)_ - one or more configuration keywords to be updated in the Harper configuration file
15+
- `clustering_enabled` _(optional)_ - one or more configuration keywords to be updated in the Harper configuration file
1616

1717
### Body
1818

docs/developers/operations-api/custom-functions.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ title: Custom Functions
44

55
# Custom Functions
66

7-
_These operations are deprecated._
7+
:::warning Deprecated
8+
These operations are deprecated.
9+
:::
810

911
## Custom Functions Status
1012

versioned_docs/version-4.2/developers/operations-api/advanced-json-sql-examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: Advanced JSON SQL Examples
66

77
## Create movies database
88

9-
Create a new database called "movies" using the 'create_database' operation.
9+
Create a new database called `movies` using the `create_database` operation.
1010

1111
_Note: Creating a database is optional, if one is not created HarperDB will default to using a database named `data`_
1212

versioned_docs/version-4.2/developers/operations-api/utilities.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ _Operation is restricted to super_user roles only_
207207

208208
## Set Configuration
209209

210-
Modifies the HarperDB configuration file parameters. Must follow with a restart or restart_service operation.
210+
Modifies the HarperDB configuration file parameters. Must follow with a [restart](#restart) or [restart_service](#restart-service) operation.
211211

212212
_Operation is restricted to super_user roles only_
213213

versioned_docs/version-4.3/developers/operations-api/advanced-json-sql-examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: Advanced JSON SQL Examples
66

77
## Create movies database
88

9-
Create a new database called "movies" using the 'create_database' operation.
9+
Create a new database called `movies` using the `create_database` operation.
1010

1111
_Note: Creating a database is optional, if one is not created HarperDB will default to using a database named `data`_
1212

versioned_docs/version-4.3/developers/operations-api/utilities.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ _Operation is restricted to super_user roles only_
208208

209209
## Set Configuration
210210

211-
Modifies the HarperDB configuration file parameters. Must follow with a restart or restart_service operation.
211+
Modifies the HarperDB configuration file parameters. Must follow with a [restart](#restart) or [restart_service](#restart-service) operation.
212212

213213
_Operation is restricted to super_user roles only_
214214

versioned_docs/version-4.4/developers/operations-api/advanced-json-sql-examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: Advanced JSON SQL Examples
66

77
## Create movies database
88

9-
Create a new database called "movies" using the 'create_database' operation.
9+
Create a new database called `movies` using the `create_database` operation.
1010

1111
_Note: Creating a database is optional, if one is not created Harper will default to using a database named `data`_
1212

0 commit comments

Comments
 (0)