Skip to content

Commit

Permalink
Fix minor typographical issues in docs (#490)
Browse files Browse the repository at this point in the history
Co-authored-by: Eric Saxby <77073+sax@users.noreply.github.com>
  • Loading branch information
sax and sax authored Dec 10, 2023
1 parent 255540a commit 2361efa
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The library leverages [protobuf](https://github.com/protocolbuffers/protobuf) as

### What is a subsystem?

A subsystem is a smaller and scoped subsection of the library composed of RPCs and services. Subsystems are similar to "packages" or "modules" in programming languages such as [Rust](https://github.com/rust-lang/rust/tree/master/library/core/src). Kubernetes as API groups, and Linux itself has subsystems.
A subsystem is a smaller and scoped subsection of the library composed of RPCs and services. Subsystems are similar to "packages" or "modules" in programming languages such as [Rust](https://github.com/rust-lang/rust/tree/master/library/core/src). Kubernetes has API groups, and Linux itself has subsystems.

Each subsystem is unique. Each subsystem is liable to come with its own guarantees, and expectations.

Expand Down
6 changes: 3 additions & 3 deletions docs/auraed/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ To run auraed as a standard library server you can run the daemon alongside your

We suggest using the [aurae](https://github.com/aurae-runtime/aurae) repository for building all parts of the project.

If you intend on building this repository directly you can leverage the Makefile in this repository.
If you intend on building this repository directly you can leverage the Makefile in this repository:

```bash
make auraed
```

or using Cargo directly
or use Cargo directly:

```bash
cargo clippy
Expand All @@ -39,7 +39,7 @@ It is possible to run auraed in a container as long as the following is consider
- Populating mTLS certificate material into the container.
- Exposing either the socket or a network interface from the container for client connections.

Building the container (replace with your values).
Building the container (replace with your values):

```
sudo -E docker build -t krisnova/aurae:latest -t krisnova/aurae:$sha -f images/Dockerfile.nested .
Expand Down
6 changes: 3 additions & 3 deletions docs/community/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ Welcome to The Aurae Runtime project.

The project name is pronounced like the English word "aura" and is named after a minor Greek/Roman mythological deity, whose name means "breeze".

Aurae a [Nivenly Foundation](https://github.com/nivenly) project and agrees to abide by the Nivenly covenant.
Aurae is a [Nivenly Foundation](https://github.com/nivenly) project and agrees to abide by the Nivenly covenant.

# Getting Involved

If you would like to get involved with Aurae development.
If you would like to get involved with Aurae development:

- Join our [discord](https://discord.gg/aTe2Rjg5rq).
- Read the [Nivenly Covenant](https://nivenly.org/covenant) which calls out the code of conduct.
Expand All @@ -19,4 +19,4 @@ If you would like to get involved with Aurae development.

[Aurae](https://github.com/aurae-runtime/aurae) is an opinionated turing complete scripting language built for the enterprise. Think of it like TypeScript for infrastructure platforms.

[Auraed](https://github.com/aurae-runtime/auraed) is the project core runtime daemon, auth and identity management system, and gRPC server that listens on a Unix domain socket.
[Auraed](https://github.com/aurae-runtime/auraed) is the project core runtime daemon, auth and identity management system, and gRPC server that listens on a Unix domain socket.
10 changes: 5 additions & 5 deletions docs/stdlib/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The library leverages [protobuf](https://github.com/protocolbuffers/protobuf) as

### What is a subsystem?

A subsystem is a smaller and scoped subsection of the library composed of RPCs and services. Subsystems are similar to "packages" or "modules" in programming languages such as [Rust](https://github.com/rust-lang/rust/tree/master/library/core/src). Kubernetes as API groups, and Linux itself has subsystems.
A subsystem is a smaller and scoped subsection of the library composed of RPCs and services. Subsystems are similar to "packages" or "modules" in programming languages such as [Rust](https://github.com/rust-lang/rust/tree/master/library/core/src). Kubernetes has API groups, and Linux itself has subsystems.

Each subsystem is unique. Each subsystem is liable to come with its own guarantees, and expectations.

Expand All @@ -20,7 +20,7 @@ For example, Aurae has the concept of an `Executable` resource which represents

The core resources are intended to be fundamental and composable, similar to the objects and structures found in modern programming languages.

Resources are defined directly in the corresponding protobuf definition and later generated into code for various languages. A resource's corresponding message should never be passed to directly to, or received directly from an RPC.
Resources are defined directly in the corresponding protobuf definition and later generated into code for various languages. A resource's corresponding message should never be passed directly to or received directly from an RPC.

In protobuf terms a resource is a [message](https://protobuf.dev/programming-guides/proto3/#simple).

Expand All @@ -31,13 +31,13 @@ Services are a section of the API designed to be a way of grouping functionality
A service should be discreet in the terms of how it mutates the system. For example if a service starts, it should stop. If a service allocates, it should free. And so on.

Services should be named after a resource or set of functionality around common resources.
Services should follow the `service NameService` paradigm as defined in the [style guide](https://protobuf.dev/programming-guides/style/)
Services should follow the `service NameService` paradigm as defined in the [style guide](https://protobuf.dev/programming-guides/style/).

For example the service that mutates a `Cell` should be called `CellService`.

### What are functions?

A function is a discreet piece of functionality designed to execute on the "backend", or directly by an Aurae Daemon server.
A function is a discreet piece of functionality designed to execute on the "backend," or directly by an Aurae Daemon server.

The library is designed to be executed procedurally and quickly. Many function calls per second is a reasonable expectation for any client.

Expand Down Expand Up @@ -89,7 +89,7 @@ enum FooBar {
}
```

A notable exception to the public specification above is the Aurae projects preference for standardizing the objects that are used as the request and response messages.
A notable exception to the public specification above is the Aurae project's preference for standardizing the objects that are used as the request and response messages.

The traditional convention that is meant to reduce the likelihood of future breaking changes and ease the creation of macros for generating code:

Expand Down

0 comments on commit 2361efa

Please sign in to comment.