From d6cd5090ab643a08d01ee6c0cde25b4a138e773e Mon Sep 17 00:00:00 2001 From: iverly Date: Tue, 24 Oct 2023 18:15:19 +0200 Subject: [PATCH] feat: add introduction page Signed-off-by: iverly --- pages/docs/_meta.json | 6 +- pages/docs/getting-started/configuration.mdx | 28 ++++++++++ pages/docs/getting-started/example-node.mdx | 13 +++++ pages/docs/index.mdx | 59 +++++++++++++++++--- 4 files changed, 96 insertions(+), 10 deletions(-) create mode 100644 pages/docs/getting-started/configuration.mdx create mode 100644 pages/docs/getting-started/example-node.mdx diff --git a/pages/docs/_meta.json b/pages/docs/_meta.json index e7e884e..77df572 100644 --- a/pages/docs/_meta.json +++ b/pages/docs/_meta.json @@ -1,7 +1,7 @@ { - "-- Getting Started --": { + "-- Quickstart --": { "type": "separator", - "title": "Getting Started" + "title": "Quickstart" }, - "index": "Introduction" + "index": "Introduction", } diff --git a/pages/docs/getting-started/configuration.mdx b/pages/docs/getting-started/configuration.mdx new file mode 100644 index 0000000..f927956 --- /dev/null +++ b/pages/docs/getting-started/configuration.mdx @@ -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. + + + 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. + diff --git a/pages/docs/getting-started/example-node.mdx b/pages/docs/getting-started/example-node.mdx new file mode 100644 index 0000000..1ceb85c --- /dev/null +++ b/pages/docs/getting-started/example-node.mdx @@ -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). diff --git a/pages/docs/index.mdx b/pages/docs/index.mdx index 1ceb85c..600c90e 100644 --- a/pages/docs/index.mdx +++ b/pages/docs/index.mdx @@ -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).