Skip to content

Commit 1dc9063

Browse files
Apply suggestions from code review
Co-authored-by: Chris Barber <[email protected]>
1 parent 4e12356 commit 1dc9063

File tree

5 files changed

+12
-12
lines changed

5 files changed

+12
-12
lines changed

docusaurus.config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ const config: Config = {
6666
path: 'learn',
6767
routeBasePath: 'learn',
6868
sidebarPath: './sidebarsLearn.ts',
69-
editUrl: 'https://github.com/HarperDB/documentation/blob/main/',
69+
editUrl: 'https://github.com/HarperFast/documentation/blob/main/',
7070
},
7171
],
7272
// Main documentation

learn/getting-started/create-your-first-application.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,13 +45,13 @@ At the bottom are the **core services** that make up the foundation of the Harpe
4545

4646
**Plugins** come next in the stack. Plugins have access to APIs exposing many of Harper's core services, and are capable of implementing more advanced features than what the core services provide. Many of Harper's features are implemented as **built-in plugins**. Additional features can be implemented as **custom plugins**. In this guide, we'll be demonstrating some of Harper's built-in plugins `graphqlSchema` and `rest`. Later guides will demonstrate many more.
4747

48-
And finally, the top of the stack are **applications**. This is where any user-facing functionality is implemented. Applications use plugins to implement their business logic. Everything from database table schemas, to web applications.
48+
And finally, the top of the stack are **applications**. This is where any user-facing functionality is implemented. Applications use plugins to implement their business logic, everything from database table schemas to web applications.
4949

50-
The key difference between plugins and applications is that plugins enable the functionality, and applications implement it. Its similar to that of a front-end framework. React on its own doesn't actually do anything, you actually need to build a "React App" for it to do anything meaningful.
50+
The key difference between plugins and applications is that plugins enable the functionality and applications implement it. It's similar to that of a front-end framework. React on its own doesn't actually do anything, you actually need to build a "React App" for it to do anything meaningful.
5151

5252
## Initializing the Harper Application
5353

54-
Lets get started building your first Harper application!
54+
Let's get started building your first Harper application!
5555

5656
<Tabs groupId="installation">
5757
<TabItem value="local" label="Local Installation">
@@ -65,9 +65,9 @@ git clone https://github.com/HarperFast/create-your-first-application.git first-
6565
</TabItem>
6666
<TabItem value="fabric" label="Fabric">
6767

68-
From the Cluster page, navigate to the Applications tab and click on "New Application" on the left-hand sidebar.
68+
From the "Cluster" page, navigate to the "Applications" tab and click on "New Application" on the left-hand sidebar.
6969

70-
Give the application a name such as "first-harper-app", and then click on the "Import" tab.
70+
Give the application a name such as "first-harper-app", then click on the "Import" tab.
7171

7272
Specify `https://github.com/HarperFast/create-your-first-application` in the "Git Repository URL" field.
7373

@@ -201,7 +201,7 @@ If you look closely at the Harper logs, a new line should be added to the system
201201
REST: HTTP: 9926
202202
```
203203

204-
This line tells you that the Harper REST API is configured on port `9926` (this is configurable, and this value is the default).
204+
This line tells you that the Harper REST API is configured on port `9926` (this is configurable and this value is the default).
205205

206206
</TabItem>
207207
<TabItem value="fabric" label="Fabric">

learn/getting-started/install-and-connect-harper.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Then, execute the Harper CLI:
4747
harper
4848
```
4949

50-
When installing locally on your machine, you can specify any destination for Harper, we recommend using something within your home directory such as `$HOME/hdb`. Keep note of what you specify for the username and password, and make sure you select the `dev` default config and set the hostname to `localhost`.
50+
When installing locally on your machine, you can specify any destination for Harper, we recommend using something within your home directory such as `$HOME/hdb`. Keep note of what you specify for the username and password. Make sure you select the `dev` default config and set the hostname to `localhost`.
5151

5252
:::important
5353
Do not actually enter `$HOME` in the destination prompt; it should automatically fill in the value of your home directory. Otherwise, specify the absolute path for the Harper installation.
@@ -158,15 +158,15 @@ Note that log messages are being sent to the console (stdout and stderr) in addi
158158
This server does not have valid usage licenses, this should only be used for educational and development purposes.
159159
```
160160

161-
This initial output contains a lot of helpful information. After the ASCII logo, there are a number of important log lines displaying the application process ID, the debugger endpoint, and domain socket path, and the Harper application version. Log lines are always prepended with the thread name, number, and then log level. `[main/0]` is the main thread, and `[http/1]` is the singular, additional worker thread. `[info]` is the default log level. After the log lines is specific application configuration information. It shows the application hostname, the number of worker threads, where Harper was installed, is the debugger enabled, logging level and location, and then ports, CORS, and socket path details for various networking protocols. We'll explain all of these in due time.
161+
This initial output contains a lot of helpful information. After the ASCII logo, there are a number of important log lines displaying the application process ID, the debugger endpoint, the domain socket path, and the Harper application version. Log lines are always prepended with the thread name, number, and log level. `[main/0]` is the main thread. `[http/1]` is the singular, additional worker thread. `[info]` is the default log level. After the log lines is specific application configuration information. It shows the application hostname, the number of worker threads, where Harper was installed, is the debugger enabled, logging level and location followed by ports, CORS, and socket path details for various networking protocols. We'll explain all of these in due time.
162162

163163
Interrupting the process (`CTRL/CMD + C`) will shut down Harper.
164164

165165
With Harper successfully running, skip ahead to [Performing a health check](#performing-a-health-check) to learn how to verify your local Harper instance is running and complete this getting started guide. Or continue reading for more information on getting started with Harper Fabric.
166166

167167
## Getting started with Fabric
168168

169-
Fabric is our service for managing and deploying Harper on a distributed network. Fabric makes it easy to create new Harper clusters, the Harper application platform running on distributed nodes, and deploy your application to this service. Fabric has a management interface, and provides a UI for managing your deployments and even your local instance that you just installed. You can sign up for Fabric for free, and create a free Harper cluster to deploy your application:
169+
Fabric is our service for managing and deploying Harper on a distributed network. Fabric makes it easy to create new Harper clusters, the Harper application platform running on distributed nodes, and deploy your application to this service. Fabric has a management interface, and provides a UI for managing your deployments and even your local instance that you just installed. You can sign up for Fabric for free and create a free Harper cluster to deploy your application:
170170

171171
- Go to [Fabric](https://fabric.harper.fast) and sign-up for a new account.
172172
- You will need to agree to the terms of service and verify your email address.

learn/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Most guides present both local-based and [Harper Fabric](https://fabric.harper.f
1515

1616
<GeneralPrerequisites />
1717

18-
If you ever have questions, join our official community [Discord](https://harper.fast/discord). Furthermore, Harper documentation is open source, if you notice anything out-of-place with the guide content, please [open an issue](https://github.com/HarperFast/documentation/issues) or submit changes directly using the "Edit this page" link at the bottom of every page.
18+
If you ever have questions, join our official community [Discord](https://harper.fast/discord). Harper documentation is open source. If you notice anything out-of-place with the guide content, please [open an issue](https://github.com/HarperFast/documentation/issues) or submit changes directly using the "Edit this page" link at the bottom of every page.
1919

2020
:::info
2121

src/components/learn/general-prerequisites.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
- `sudo` is not required
33
- For local development, Harper requires permission to read/write files and localhost networking permissions
44
- HTTP client of choice
5-
- Most examples will present both curl and fetch based HTTP requests
5+
- Most examples will present both curl and fetch-based HTTP requests
66
- GUI-based HTTP clients will also work fine
77
- Node.js Current, Active LTS, or Maintenance LTS version
88
- For updated Node.js installation instructions refer to the official [Download Node.js](https://nodejs.org/en/download) page

0 commit comments

Comments
 (0)