Skip to content
This repository was archived by the owner on May 20, 2025. It is now read-only.

Commit 47939c3

Browse files
committed
chore: updates documentation
Updates documentation to correct typos, provide accurate links, and improve clarity. This includes: - Correcting a typo in the keyvalue documentation. - Updating an outdated link in the azure provider documentation. - Improving the gcloud install instructions. - Correcting a typo in the schedules documentation.
1 parent aab7887 commit 47939c3

File tree

4 files changed

+12
-7
lines changed

4 files changed

+12
-7
lines changed

docs/keyvalue.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Key value stores act as a database which provides the functionality for efficien
1616

1717
### Key
1818

19-
A key is a unique string that acts as a references to a value. Anytime a value is updated or read from a key value store, it is done so by referencing the key.
19+
A key is a unique string that acts as a reference to a value. Anytime a value is updated or read from a key value store, it is done so by referencing the key.
2020

2121
### Value
2222

docs/providers/pulumi/azure.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ provider: nitric/azure@latest
1818
<Note>
1919
Nitric runs services (APIs, Schedules and Topic Subscribers) on Azure
2020
Container Apps, which is unavailable in a [small number of
21-
regions](https://azure.microsoft.com/en-au/explore/global-infrastructure/products-by-region/?products=container-apps&regions=all).
21+
regions](https://azure.microsoft.com/en-us/explore/global-infrastructure/products-by-region/?products=container-apps&regions=all).
2222
</Note>
2323
2424
The Azure provider is supported by the Nitric SDKs and CLI by default. However, credentials for an Azure account will be required when using the [up command](/reference/cli) from the CLI.

docs/providers/pulumi/gcp.mdx

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,14 @@ Download & install the [latest CLI release](https://cloud.google.com/sdk/install
4040
<TabItem label="Linux">
4141

4242
```bash
43-
curl -O https://dl.google.com/dl/cloudsdk/channels/rapid/downloads/google-cloud-sdk-378.0.0-linux-x86_64.tar.gz
43+
# Download the latest version
44+
curl -O https://dl.google.com/dl/cloudsdk/channels/rapid/downloads/google-cloud-cli-linux-x86_64.tar.gz
45+
46+
# Extract the archive
47+
tar -xf google-cloud-cli-linux-x86_64.tar.gz
48+
49+
# Run the install script
50+
./google-cloud-sdk/install.sh
4451
```
4552

4653
</TabItem>

docs/schedules.mdx

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ import (
7979

8080
func main() {
8181
// Run every 5 minutes
82-
nitric.NewSchedule("process-transactions").Every("5 minutues", func(ctx *schedules.Ctx) {
82+
nitric.NewSchedule("process-transactions").Every("5 minutes", func(ctx *schedules.Ctx) {
8383
fmt.Printf("processing at %s\n", time.Now().Format(time.RFC3339))
8484
})
8585
// Run at 22:00 Monday through Friday.
@@ -97,15 +97,13 @@ import 'package:nitric_sdk/nitric.dart';
9797
// run every 5 minutes
9898
Nitric.schedule("process-transactions").every("5 minutes", (ctx) async {
9999
// add code to run here
100-
print("processing transaction")
101-
return ctx;
100+
print("processing transaction");
102101
});
103102
104103
// Run at 22:00 Monday through Friday
105104
Nitric.schedule("send-reminder").cron("0 22 * * 1-5", (ctx) async {
106105
// add code to run here
107106
print("sending reminder");
108-
return ctx;
109107
});
110108
```
111109

0 commit comments

Comments
 (0)