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

Commit 903568e

Browse files
committed
update structure and links
1 parent 10c25f9 commit 903568e

File tree

55 files changed

+224
-172
lines changed

Some content is hidden

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

55 files changed

+224
-172
lines changed

docs/basics/project-structure.mdx

Lines changed: 0 additions & 61 deletions
This file was deleted.

docs/faq.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Nope, the Nitric CLI can run applications for development and testing directly o
1010

1111
## What programming languages does Nitric support?
1212

13-
Nitric's API is built on gRPC. There are SDKs already available for [several languages](/concepts/language-support), and gRPC also provides support and code generation for many other languages. If you'd like to work on a new language SDK, reach out in [Discord](https://nitric.io/chat).
13+
Nitric's API is built on gRPC. There are SDKs already available for [several languages](/reference/languages), and gRPC also provides support and code generation for many other languages. If you'd like to work on a new language SDK, reach out in [Discord](https://nitric.io/chat).
1414

1515
## Does Nitric help with data portability?
1616

docs/further-reading/how-devs-use-nitric.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Projects can have as many service files as desired, and each one will map to a c
1414

1515
The Nitric SDK offers a comprehensive set of tools, including handlers for events/topics, queues, storage, key-value (KV) stores, schedules, APIs and secrets. These components are the essential building blocks for building cloud applications.
1616

17-
SDKs communicate with the Nitric Server using gRPC and Protocol Buffers, which enables the framework to support [many languages](/concepts/language-support). Resources defined in the SDK do not require low-level configuration, which means that application code will never contain parameters or annotations for config, such as the replication policies for data stores. This fine-grained control is handled by [Providers](/concepts/how-ops-use-nitric#nitric-providers), which are described in the Ops workflow.
17+
SDKs communicate with the Nitric Server using gRPC and Protocol Buffers, which enables the framework to support [many languages](/reference/languages). Resources defined in the SDK do not require low-level configuration, which means that application code will never contain parameters or annotations for config, such as the replication policies for data stores. This fine-grained control is handled by [Providers](/foundations/deployment/providers), which are described in the Ops workflow.
1818

1919
## Local Cloud Emulation
2020

docs/further-reading/how-nitric-works.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,4 @@ A combination of a Runtime and Deployment Plugin in Nitric is called a “provid
2929

3030
## Language SDKs
3131

32-
Language SDKs enable Nitric to support various programming languages and execution environments. Language support is idiomatic, designed to feel familiar to developers of each language and make the best use of unique language features. Community support is offered for the [following languages](/concepts/language-support).
32+
Language SDKs enable Nitric to support various programming languages and execution environments. Language support is idiomatic, designed to feel familiar to developers of each language and make the best use of unique language features. Community support is offered for the [following languages](/reference/languages).

docs/basics/deployment.mdx renamed to docs/get-started/foundations/deployment/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: 'How to deploy Nitric applications'
66

77
Nitric applications are decoupled from the underlying hosting provider, allowing you to develop your application locally and deploy it to your preferred cloud provider or another platform without these concerns bleeding into the application code.
88

9-
You can read more the [concepts](/concepts/how-nitric-works) behind Nitric to understand why this separation is important and how it is achieved. This page will focus on the deployment process and how to configure your application for deployment.
9+
You can read about why this separation is important on the [why nitric](/foundations/why-nitric) page. This page will focus on the deployment process and how to configure your application for deployment.
1010

1111
<Note>
1212
If you're new to Nitric we recommend starting with the [quickstart
@@ -64,7 +64,7 @@ You can also extend the existing providers to change which cloud services are us
6464

6565
## Deploying your application
6666

67-
Read the concepts page on [deployment](/concepts/deployment) to understand how Nitric prepares your application for deployment. This section focuses on how to configure your application for deployment and how to deploy it.
67+
This section focuses on how to configure your application for deployment and how to deploy it.
6868

6969
There are two primary commands for deploying your application with Nitric:
7070

docs/concepts/infrastructure-from-code.mdx renamed to docs/get-started/foundations/infrastructure/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
description: Introducing the concept of Infrastructure from Code (IfC) and how Nitric uses it to automate infrastructure and deployment.
2+
description: Nitric allows applications to declare infrastructure requirements and generate the cloud infrastructure automation needed to deploy and manage the services, using Infrastructure-from-Code.
33
---
44

5-
# Infrastructure from Code (IfC)
5+
# Infrastructure
66

77
Infrastructure from Code (IfC) is an extension of Infrastructure as Code (IaC) that takes runtime application code into consideration and enhances Separation of Concerns (SoC).
88

File renamed without changes.
File renamed without changes.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
description: 'Nitric Services Overview'
3+
---
4+
5+
# Services
6+
7+
In Nitric, a service is an entrypoint for your application's logic. Each service represents a specific task or function your app needs to handle, such as managing APIs, processing events, handling web socket connections, or running scheduled tasks. Services are designed to be highly flexible and scalable, meaning you can have a single service handling multiple routes or create multiple services that each handle specific tasks.
8+
9+
## How Services Work
10+
11+
When you define a service in your nitric.yaml file, Nitric automatically takes care of turning it into a container. Each service can then run independently, allowing your app to scale and manage different workloads efficiently. Services can interact with resources like databases, queues, and buckets, which are defined separately but linked at runtime by Nitric.
12+
13+
## Standard Services
14+
15+
## Batch Services
16+
17+
Batch services are designed to process large amounts of data in a single operation. They are ideal for tasks like data processing, image resizing, or running scheduled jobs. Batch services can be triggered by events, run on a schedule, or be manually invoked.

docs/basics/configuration.mdx renamed to docs/get-started/foundations/projects/configuration.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: 'Configuring a Nitric Project using nitric.yaml'
44

55
# Configuration
66

7-
The Nitric CLI uses a configuration file named `nitric.yaml` to define the structure of your project. This file defines the name of your project, where nitric should look for the entrypoints to your application, and other project-specific settings.
7+
The Nitric CLI uses a configuration file named `nitric.yaml` to define the structure of your project. This file specifies the name of your project, where nitric should look for the entrypoints to your application, and other project-specific settings.
88

99
Projects created from a template using the Nitric CLI will have a `nitric.yaml` file created for you. If you are creating a project from scratch, you can create a `nitric.yaml` file in the root of your project.
1010

@@ -39,7 +39,7 @@ The name of your project. This is used to identify your project and it used when
3939

4040
### `services`
4141

42-
A list of [service](/concepts/service) types that make up your project. Typically, nitric will build each service in your project into a separate container image. Each service can have its own runtime, build configuration, and start command.
42+
A list of [service](/foundations/infrastructure/services) types that make up your project. Typically, nitric will build each service in your project into a separate container image. Each service can have its own runtime, build configuration, and start command.
4343

4444
#### `match`
4545

@@ -95,7 +95,7 @@ If a runtime is provided it must match the name of a runtime configuration in th
9595

9696
Type is essentially the name for this group of services. It is used to group services together for deployment and resource management. If not provided, the service will be grouped under the 'default' type.
9797

98-
The most common use case for this is grouping service with similar deployed resource requirements together. For example, you make have a set of services that required additional vCPU or memory resources at runtime. You can group these services together under a specific type and apply resource constraints to that type in a [stack file](/concepts/stack).
98+
The most common use case for this is grouping service with similar deployed resource requirements together. For example, you make have a set of services that required additional vCPU or memory resources at runtime. You can group these services together under a specific type and apply resource constraints to that type in a [stack file](/foundations/deployment/stacks).
9999

100100
For example, if you have a set of services that require additional memory, you can group them together under a type named `memory-intensive`, separate from the default type.
101101

@@ -144,9 +144,9 @@ go run ./services/service2/main.go
144144

145145
### `batch-services` (optional)
146146

147-
A list of [batch service](/concepts/batch-service) types that make up your project. Batch services are used to run high-performance computing tasks, data processing or tasks requiring GPUs, or a large number of vCPUs or memory.
147+
A list of [batch service](/foundations/infrastructure/services#batch-services) types that make up your project. Batch services are used to run high-performance computing tasks, data processing or tasks requiring GPUs, or a large number of vCPUs or memory.
148148

149-
Batch services are similar to services but are optimized for running batch processing tasks. You can read more about batch services in the [batch services](/concepts/service#batch) section.
149+
Batch services are similar to services but are optimized for running batch processing tasks. You can read more about batch services in the [batch service](/foundations/infrastructure/services#batch-services) section.
150150

151151
The configuration options for `batch-services` are the same as for `services`.
152152

0 commit comments

Comments
 (0)