Skip to content

Commit

Permalink
feat: add introduction page
Browse files Browse the repository at this point in the history
Signed-off-by: iverly <github@iverly.net>
  • Loading branch information
iverly committed Oct 24, 2023
1 parent d02004f commit d6cd509
Show file tree
Hide file tree
Showing 4 changed files with 96 additions and 10 deletions.
6 changes: 3 additions & 3 deletions pages/docs/_meta.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"-- Getting Started --": {
"-- Quickstart --": {
"type": "separator",
"title": "Getting Started"
"title": "Quickstart"
},
"index": "Introduction"
"index": "Introduction",
}
28 changes: 28 additions & 0 deletions pages/docs/getting-started/configuration.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import { Callout } from 'nextra/components';

# Introduction

Welcome to the documentation of Faast, a cutting-edge Function as a Service
(FaaS) server designed to maximize both efficiency and functionality. Developed
in the Rust programming language, known for its performance and safety, Faast
embodies a remarkable blend of robustness and agility, essential in modern
serverless architectures.

A unique aspect of Faast is its tailored execution environment. The system
utilizes an initramfs and a bespoke Linux kernel, each constructed expressly for
Faast's operational requirements. The initramfs contains a specialized SDK of
the language in use (e.g., Node) and an agent that facilitates GRPC
communication between the virtual machine and the API. In contrast, the Linux
kernel operates without an initramfs and employs the newc compression format,
optimizing the system's performance.

Through these meticulously engineered components and environments, Faast
transcends conventional FaaS offerings, providing a high-performance, reliable,
and extensible platform capable of meeting the demanding needs of contemporary
serverless computing landscapes.

<Callout type="info">
This command will prompt you for the properties needed to generate the
project. For more information on the properties, see the [Template
Properties](/template-properties) page.
</Callout>
13 changes: 13 additions & 0 deletions pages/docs/getting-started/example-node.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Introduction

Welcome to Nextra! This is a basic docs template. You can use it as a starting
point for your own project :)

## What is Nextra?

A **simple**, **powerful** and **flexible** site generation framework with
everything you love from Next.js.

## Documentation

The documentation is available at [https://nextra.site](https://nextra.site).
59 changes: 52 additions & 7 deletions pages/docs/index.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,58 @@
---
title: 'Faast Documentation'
description:
'Welcome to the documentation of Faast, a cutting-edge Function as a Service
(FaaS) server designed to maximize both efficiency and functionality.'
---

import { Callout } from 'nextra/components';

# Introduction

Welcome to Nextra! This is a basic docs template. You can use it as a starting
point for your own project :)
Welcome to the documentation of Faast, a cutting-edge Function as a Service
(FaaS) server designed to maximize both efficiency and functionality. Developed
in the Rust programming language, known for its performance and safety, Faast
embodies a remarkable blend of robustness and agility, essential in modern
serverless architectures.

A unique aspect of Faast is its tailored execution environment. The system
utilizes an initramfs and a bespoke Linux kernel, each constructed expressly for
Faast's operational requirements. The initramfs contains a specialized SDK of
the language in use (e.g., Node) and an agent that facilitates GRPC
communication between the virtual machine and the API. In contrast, the Linux
kernel operates without an initramfs and employs the newc compression format,
optimizing the system's performance.

Through these meticulously engineered components and environments, Faast
transcends conventional FaaS offerings, providing a high-performance, reliable,
and extensible platform capable of meeting the demanding needs of contemporary
serverless computing landscapes.

## Features

- The utilization of a custom initramfs and Linux kernel, along with
language-specific SDKs, ensures optimized performance and communication
between the VM and the API.
- Faast dynamically receives and executes function code via API without
retaining the function, ensuring lightweight operation and real-time code
execution.
- Faast enables streamlined virtual machine launch and management, enhancing the
efficiency of function execution.
- Faast offers a robust and high-speed platform suitable for high-demand
serverless computing scenarios.
- The use of GRPC for communication between the VM and the API provides a
modern, protocol-buffer based method for ensuring efficient, robust, and
secure inter-component communication.

## License

Distributed under the Apache 2.0 License. See `LICENSE` for more information.

## What is Nextra?
## Authors

A **simple**, **powerful** and **flexible** site generation framework with
everything you love from Next.js.
This project was initialy developed by the Polytech DO teams in April 2023.

## Documentation
## About the Project

The documentation is available at [https://nextra.site](https://nextra.site).
For more information about the project, please visit our
[GitHub organization](https://github.com/faast-rt).

0 comments on commit d6cd509

Please sign in to comment.