Skip to content

Commit

Permalink
fix typo and add links
Browse files Browse the repository at this point in the history
  • Loading branch information
Maxtho8 committed Nov 20, 2023
1 parent 9ab5233 commit f3fbff6
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 25 deletions.
21 changes: 9 additions & 12 deletions pages/docs/advanced/getting-involved.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,30 +13,27 @@ aims to achieve and the guidelines you need to follow. This ensures that your
contributions are in line with the project’s goals.

- Read the documentation to understand how Faast works.
- Take a look at our [GitHub repository](link_to_repository) to see how the
project is structured.
- Take a look at our [GitHub repository](https://github.com/faast-rt/lambdo) to
see how the project is structured.

2. **Set Up Your Development Environment**:

Ensure that you have all the necessary tools and dependencies installed to work
on the project. Setting up your environment correctly helps prevent issues down
the line.

- Follow our [installation guide](link_to_installation_guide)

3. **Join Our Community**:

- Join our [Discord](link_to_installation_guide) to participate in discussions
and share your ideas. You can also ask questions and get help from the
community.
- Follow our
[installation guide](https://faast-rt.com/docs/getting-started/installation)

## How to Contribute?

Please ensure you read and adhere to our
[Contributing Guide](link_to_contributing_guide) to streamline the process and
align your contributions with the project's standards.
[Contributing Guide](https://github.com/faast-rt/lambdo/blob/main/CONTRIBUTING.md)
to streamline the process and align your contributions with the project's
standards.

## Code of Conduct

We want Faast to be a welcoming and respectful environment. Please read and
follow our [Code of Conduct](link_to_code_of_conduct).
follow our
[Code of Conduct](https://github.com/faast-rt/lambdo/blob/main/CODE_OF_CONDUCT.md).
25 changes: 12 additions & 13 deletions pages/docs/advanced/project-structure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

## Agent

The `agent` directory contains the code necessary to generate the agent that is
executed within the Virtual Machine (VM) and is responsible for executing the
The `agent` directory contains the code necessary to generate the agent that
executes within the Virtual Machine (VM) and is responsible for executing the
code.

### build.rs
Expand All @@ -15,18 +15,17 @@ the server and the client for gRPC communication outside of the VM.

Inside the `lib` directory, you will find:

> #### API
#### API

The `API` folder contains the code required to create both a gRPC client and
server using tonic, as well as the definition of the gRPC fields. These
definitions are generated thanks to the `build.rs` file. Please note that
`grpc_definition.rs` is an automatically generated file and should not be
modified manually.
definitions are generated by the `build.rs` file. Note that `grpc_definition.rs`
is an automatically generated file and should not be modified manually.

> #### Runner Engine
#### Runner Engine

The runner engine, also located within the `lib` directory, is responsible for
creating the workspace and executing the code received from the users.
The runner engine, also located within the `lib` directory, is responsible for
creating the workspace and executing the code received from the users.

## API

Expand All @@ -45,9 +44,9 @@ requests and responses.

The `config.rs` file holds the definition of data structures and functions
required for loading and manipulating a specific configuration (`LambdoConfig`)
from a YAML file. This configuration is utilized to parameterize various aspects
of Lambdo, including the Virtual Machine Monitor (VMM), API, agent, and
supported programming languages.
from a YAML file. This configuration is used to parameterize various aspects of
Lambdo, including the Virtual Machine Monitor (VMM), API, agent, and supported
programming languages.

### api (Subdirectory)

Expand All @@ -63,7 +62,7 @@ VMs. Additionally, the `grpc_server.rs` file houses the gRPC server where agents
from the VMs register upon VM startup. This server manages the state of all the
VMs.

> #### net.rs
#### net.rs

The `net.rs` file is responsible for configuring the network layer of the VMs,
assigning them IP addresses and network interfaces.
Expand Down

0 comments on commit f3fbff6

Please sign in to comment.