fix typos and broken links

davemooreuws · davemooreuws · commit 63900090c956 · 2025-02-11T12:52:22.000+11:00
diff --git a/docs/apis.mdx b/docs/apis.mdx
@@ -345,7 +345,7 @@ APIs can include security definitions for OIDC-compatible providers such as [Aut
 
 APIs can be configured to automatically authenticate and allow or reject incoming requests. A `securityDefinitions` object can be provided, which _defines_ the authentication requirements that can later be enforced by the API.
 
-The security definition describes the kind of authentication to perform and the configuration required to perform it. For a [JWT](https://jwt.io/) this configuration includes the JWT issuer and audiences.
+The security definition describes the kind of authentication to perform and the configuration required to perform it. For a [JWT](https://jwt.io) this configuration includes the JWT issuer and audiences.
 
 <Note>
   Security definitions only define **available** security requirements for an
diff --git a/docs/architecture/apis.mdx b/docs/architecture/apis.mdx
@@ -168,5 +168,5 @@ SDK Reference by language -
 
 **Operations** will use or extend the Nitric Terraform reference modules:
 
-- [AWS API Terrform Module](https://github.com/nitrictech/nitric/blob/main/cloud/aws/deploytf/.nitric/modules/api/main.tf)
-- [GCP API Terrform Module](https://github.com/nitrictech/nitric/blob/main/cloud/gcp/deploytf/.nitric/modules/api/main.tf)
+- [AWS API Terraform Module](https://github.com/nitrictech/nitric/blob/main/cloud/aws/deploytf/.nitric/modules/api/main.tf)
+- [GCP API Terraform Module](https://github.com/nitrictech/nitric/blob/main/cloud/gcp/deploytf/.nitric/modules/api/main.tf)
diff --git a/docs/architecture/buckets.mdx b/docs/architecture/buckets.mdx
@@ -157,5 +157,5 @@ SDK Reference by language -
 
 **Operations** will use or extend the Nitric Terraform reference modules:
 
-- [AWS Storage Bucket Terrform Module](https://github.com/nitrictech/nitric/blob/main/cloud/aws/deploytf/.nitric/modules/bucket/main.tf)
-- [GCP Storage Bucket Terrform Module](https://github.com/nitrictech/nitric/blob/main/cloud/gcp/deploytf/.nitric/modules/bucket/main.tf)
+- [AWS Storage Bucket Terraform Module](https://github.com/nitrictech/nitric/blob/main/cloud/aws/deploytf/.nitric/modules/bucket/main.tf)
+- [GCP Storage Bucket Terraform Module](https://github.com/nitrictech/nitric/blob/main/cloud/gcp/deploytf/.nitric/modules/bucket/main.tf)
diff --git a/docs/architecture/keyvalue.mdx b/docs/architecture/keyvalue.mdx
@@ -133,5 +133,6 @@ SDK Reference by language -
 
 **Operations** will use or extend the Nitric Terraform reference modules:
 
-- [AWS Key/Value Store Terrform Module](https://github.com/nitrictech/nitric/blob/main/cloud/aws/deploytf/.nitric/modules/keyvalue/main.tf)
-- [GCP Key/Value Store Terrform Module](https://github.com/nitrictech/nitric/blob/main/cloud/gcp/deploytf/.nitric/modules/keyvalue/main.tf)
+- [AWS Key/Value Store Terraform Module](https://github.com/nitrictech/nitric/blob/main/cloud/aws/deploytf/.nitric/modules/keyvalue/main.tf)
+- [GCP Key/Value Store Terraform Module](https://github.com/nitrictech/nitric/blob/main/cloud/gcp/deploytf/.nitric/modules/keyvalue)
+  - KeyValue stores are created at runtime in GCP, so no Terraform module is required.
diff --git a/docs/architecture/queues.mdx b/docs/architecture/queues.mdx
@@ -130,5 +130,5 @@ SDK Reference by language -
 
 **Operations** will use or extend the Nitric Terraform reference modules:
 
-- [AWS Queue Terrform Module](https://github.com/nitrictech/nitric/blob/main/cloud/aws/deploytf/.nitric/modules/queue/main.tf)
-- [GCP Queue Terrform Module](https://github.com/nitrictech/nitric/blob/main/cloud/gcp/deploytf/.nitric/modules/queue/main.tf)
+- [AWS Queue Terraform Module](https://github.com/nitrictech/nitric/blob/main/cloud/aws/deploytf/.nitric/modules/queue/main.tf)
+- [GCP Queue Terraform Module](https://github.com/nitrictech/nitric/blob/main/cloud/gcp/deploytf/.nitric/modules/queue/main.tf)
diff --git a/docs/architecture/schedules.mdx b/docs/architecture/schedules.mdx
@@ -139,5 +139,5 @@ SDK Reference by language -
 
 **Operations** will use or extend the Nitric Terraform reference modules:
 
-- [AWS Schedule Terrform Module](https://github.com/nitrictech/nitric/blob/main/cloud/aws/deploytf/.nitric/modules/schedule/main.tf)
-- [GCP Schedule Terrform Module](https://github.com/nitrictech/nitric/blob/main/cloud/gcp/deploytf/.nitric/modules/schedule/main.tf)
+- [AWS Schedule Terraform Module](https://github.com/nitrictech/nitric/blob/main/cloud/aws/deploytf/.nitric/modules/schedule/main.tf)
+- [GCP Schedule Terraform Module](https://github.com/nitrictech/nitric/blob/main/cloud/gcp/deploytf/.nitric/modules/schedule/main.tf)
diff --git a/docs/architecture/secrets.mdx b/docs/architecture/secrets.mdx
@@ -133,5 +133,5 @@ SDK Reference by language -
 
 **Operations** will use or extend the Nitric Terraform reference modules:
 
-- [AWS Secret Terrform Module](https://github.com/nitrictech/nitric/blob/main/cloud/aws/deploytf/.nitric/modules/secret/main.tf)
-- [GCP Secret Terrform Module](https://github.com/nitrictech/nitric/blob/main/cloud/gcp/deploytf/.nitric/modules/secret/main.tf)
+- [AWS Secret Terraform Module](https://github.com/nitrictech/nitric/blob/main/cloud/aws/deploytf/.nitric/modules/secret/main.tf)
+- [GCP Secret Terraform Module](https://github.com/nitrictech/nitric/blob/main/cloud/gcp/deploytf/.nitric/modules/secret/main.tf)
diff --git a/docs/architecture/services.mdx b/docs/architecture/services.mdx
@@ -143,17 +143,17 @@ classDef edgeLabel line-height:2;
 
 ## 4. Code
 
-**Developers** write application code that implements handlers for the [api](/apis), [bucket](/buckets), [websocket](/websockets), [topic](/topics), [schedule](/schedule) resources. This code is written in files that matches the pattern(s) in the nitric.yaml file.
+**Developers** write application code that implements handlers for the [api](/apis), [storage](/storage), [websocket](/websockets), [topic](/topics), [schedule](/schedule) resources. This code is written in files that matches the pattern(s) in the nitric.yaml file.
 
 ### Nitric service configuration - nitric.yaml
 
-```json
+```yaml
 name: service-name
 services:
-    - match: services/*.ts
-      runtime: ""
-      type: ""
-      start: npm run dev:services $SERVICE_PATH
+  - match: services/*.ts
+    runtime: ''
+    type: ''
+    start: npm run dev:services $SERVICE_PATH
 ```
 
 ### HTTP Route Handler
@@ -187,5 +187,5 @@ assets.on('delete', '*', (ctx) => {
 
 **Operations** will use or extend the Nitric Terraform reference modules:
 
-- [AWS Services Terrform Module](https://github.com/nitrictech/nitric/blob/main/cloud/aws/deploytf/.nitric/modules/service/main.tf)
-- [GCP Services Terrform Module](https://github.com/nitrictech/nitric/blob/main/cloud/gcp/deploytf/.nitric/modules/service/main.tf)
+- [AWS Services Terraform Module](https://github.com/nitrictech/nitric/blob/main/cloud/aws/deploytf/.nitric/modules/service/main.tf)
+- [GCP Services Terraform Module](https://github.com/nitrictech/nitric/blob/main/cloud/gcp/deploytf/.nitric/modules/service/main.tf)
diff --git a/docs/architecture/sql.mdx b/docs/architecture/sql.mdx
@@ -119,4 +119,4 @@ SDK Reference by language -
 
 **Operations** will use or extend the Nitric Terraform reference modules:
 
-- [AWS SQL Terrform Module](https://github.com/nitrictech/nitric/blob/main/cloud/aws/deploytf/.nitric/modules/sql/main.tf)
+- [AWS SQL Terraform Module](https://github.com/nitrictech/nitric/blob/main/cloud/aws/deploytf/.nitric/modules/sql/main.tf)
diff --git a/docs/architecture/topics.mdx b/docs/architecture/topics.mdx
@@ -167,5 +167,5 @@ SDK Reference by language -
 
 **Operations** will use or extend the Nitric Terraform reference modules:
 
-- [AWS Topic Terrform Module](https://github.com/nitrictech/nitric/blob/main/cloud/aws/deploytf/.nitric/modules/topic/main.tf)
-- [GCP Topic Terrform Module](https://github.com/nitrictech/nitric/blob/main/cloud/gcp/deploytf/.nitric/modules/topic/main.tf)
+- [AWS Topic Terraform Module](https://github.com/nitrictech/nitric/blob/main/cloud/aws/deploytf/.nitric/modules/topic/main.tf)
+- [GCP Topic Terraform Module](https://github.com/nitrictech/nitric/blob/main/cloud/gcp/deploytf/.nitric/modules/topic/main.tf)
diff --git a/docs/architecture/websockets.mdx b/docs/architecture/websockets.mdx
@@ -8,7 +8,7 @@ description: 'Nitric WebSocket API'
 
 **Developers** use Nitric to define required WebSocket APIs within their application.
 
-- App code interacts with the [WebSocket resource](/websocket) through defined routes and integrations.
+- App code interacts with the [WebSocket resource](/websockets) through defined routes and integrations.
 - Developers implement backend logic to handle WebSocket connections, messages, and disconnections.
 
 **Operations** use default or overridden IaC (e.g Terraform modules) to provision the necessary resources for their target cloud.
@@ -134,4 +134,4 @@ SDK Reference by language -
 
 **Operations** will use or extend the Nitric Terraform reference modules:
 
-- [AWS WebSocket Terrform Module](https://github.com/nitrictech/nitric/blob/main/cloud/aws/deploytf/.nitric/modules/websocket/main.tf)
+- [AWS WebSocket Terraform Module](https://github.com/nitrictech/nitric/blob/main/cloud/aws/deploytf/.nitric/modules/websocket/main.tf)
diff --git a/docs/reference/python/schedule/schedule.mdx b/docs/reference/python/schedule/schedule.mdx
diff --git a/next.config.mjs b/next.config.mjs
@@ -626,6 +626,12 @@ const nextConfig = {
         basePath: false,
         permanent: true,
       })),
+      {
+        source: '/docs/reference/python/schedules/schedule',
+        destination: '/docs/reference/python/schedule/schedule',
+        basePath: false,
+        permanent: true,
+      },
     ]
   },
   async headers() {

Original file line number	Diff line number	Diff line change
`@@ -119,4 +119,4 @@ SDK Reference by language -`
`119`	`119`
`120`	`120`	`Operations will use or extend the Nitric Terraform reference modules:`
`121`	`121`
`122`		`-- [AWS SQL Terrform Module](https://github.com/nitrictech/nitric/blob/main/cloud/aws/deploytf/.nitric/modules/sql/main.tf)`
	`122`	`+- [AWS SQL Terraform Module](https://github.com/nitrictech/nitric/blob/main/cloud/aws/deploytf/.nitric/modules/sql/main.tf)`