Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: styling revamp #65

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,10 @@
npm-debug.log*
yarn-debug.log*
yarn-error.log*
/.yarn

# IDE specific
/.vscode

# Local Fleek Configs
fleek.config.json
1 change: 1 addition & 0 deletions .yarnrc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
nodeLinker: node-modules
2 changes: 1 addition & 1 deletion docs/Open-source/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ If you then still feel the need to ask a question and need clarification, we rec

We will then take care of the issue as soon as possible.

## I Want To Contribute
## I Want To Contribute {#your-first-code-contribution}

:::info Legal Notice
When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
Expand Down
10 changes: 5 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ description: Welcome to the documentation site for Fleek Network, the decentrali
category: Documentation
keywords: [introduction, documentation, getting started]
tags:
- Edge Platform
- Guide
- Learn
- Fleek Network
- Edge Platform
- Guide
- Learn
- Fleek Network
---

import ImgBannerDocs from '@site/static/img/banner-docs.png?202309041511';
import ImgBannerDocs from '@site/static/img/banner-docs.webp?202309041511';

<img className="banner" src={ImgBannerDocs} />

Expand Down
11 changes: 1 addition & 10 deletions docs/learn/delivery-acknowledgements.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ tags:
sidebarCollapsible: false
---

import Author from '@site/src/components/Author';

## Overview

When a client signs a message, it creates a Delivery Acknowledgement that confirms a successful service computation delivery by a node. This [process](#node-vs-client-process-flow) ensures the immutability and integrity of the message (the client cannot change or reverse it) and also includes metadata about the commodities consumed by the node during the service execution. This metadata helps in calculating the reward that the node will receive.
Expand Down Expand Up @@ -41,7 +39,7 @@ The periodic submission of Delivery Acknowledgements, allows us to leverage SNAR
The Fleek Network uses Narwhal as a [DAG-mempool](https://arxiv.org/pdf/2105.11827.pdf) for transaction ordering (as total ordering or linear order) and Bullshark as the consensus engine.

:::tip
Read [The Consensus Algorithm](/docs/learn/the-network#the-consensus-algorithm) section, to learn more about Narwhal and Bullshark. Alternatively, check the [whitepaper](/docs/whitepaper) for more detailed information.
Read [The Consensus Algorithm](/docs/learn/the-network#consensus) section, to learn more about Narwhal and Bullshark. Alternatively, check the [whitepaper](/docs/whitepaper) for more detailed information.
:::

Total ordering is performed by a committee-based approach. The committee is formed from a subset of any valid staked node at the end of every epoch (about 24 hours). Integrity is met due to the node rotation that occurs at each period, reducing risks associated with nodes being compromised and affecting the committee's purity.
Expand Down Expand Up @@ -75,10 +73,3 @@ Learn more about it in the [Content Addressing](/docs/learn/the-network#content-
## Delivery Acknowledgement Customization

A Service can have a custom configuration to specify how Delivery Acknowledgements should behave or work. Patterns and conventions should be expected to emerge from the Service builder community and best practices.

<Author
name="Helder Oliveira"
image="https://github.com/heldrida.png"
title="Software Developer + DX"
url="https://github.com/heldrida"
/>
9 changes: 0 additions & 9 deletions docs/learn/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ tags:
- whitepaper
---

import Author from '@site/src/components/Author';

## Introduction

The Core of Fleek Network offers a foundational layer to enable developers to build and deploy Edge Services efficiently. It abstracts away the development complexities of consensus, cryptography, storage and peer-to-peer networking, etc, to simplify things conceptually. It frees developers and teams to focus on what matters the most to reach business goals.
Expand Down Expand Up @@ -47,10 +45,3 @@ When a client requests a service, the protocol determines the best route to the
Once the computation is successful, the data streaming routes to the client. On-client request fulfillment, a proof of delivery is generated containing cryptographically secured metadata about the original request, any parts involved and the resources consumed.

The Delivery Acknowledgements are stored locally in the participating node memory pools, rolled up to the protocol consensus consistently throughout the epoch (about 24h). This agreement is formed by a random committee of any healthy Nodes that use the information provided to reward the Nodes fairly.

<Author
name="Helder Oliveira"
image="https://github.com/heldrida.png"
title="Software Developer + DX"
url="https://github.com/heldrida"
/>
9 changes: 0 additions & 9 deletions docs/learn/services.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@ tags:
- toolkit
---

import Author from '@site/src/components/Author';

## Overview

A Fleek Network Service is a modular application that runs on nodes and allows users to perform well-defined functions or some specific tasks. Services are scalable and performant due to edge computation and networking features provided by the core principles of the network.
Expand Down Expand Up @@ -137,10 +135,3 @@ This causes long finalization times and a reduction in block speeds on Layer-1,
In Fleek Network, a service builder can offer an alternative to a Layer-2 sequencer, that is decentralized and more reliable by batching and posting to Layer-1 settlement contracts. With equivalent Layer-2 settlement times.

An additional benefit can be enabling end-user gasless transaction submissions by disregarding a Layer-2 gas token to submit transactions to Layer-1.

<Author
name="Helder Oliveira"
image="https://github.com/heldrida.png"
title="Software Developer + DX"
url="https://github.com/heldrida"
/>
10 changes: 1 addition & 9 deletions docs/learn/the-network.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ tags:
sidebarCollapsible: false
---

import Author from '@site/src/components/Author';
import Ports from '../../guides/partials/_ports.mdx';

## Protocol
Expand All @@ -36,7 +35,7 @@ It's important to keep track of these components to ensure that the system is ru

As a decentralized network, the state of these is replicated across all of the distributed nodes in the network by forming a blockchain, in which consensus on transactions transmutes to the final immutable state.

## The Consensus algorithm
## The Consensus algorithm {#consensus}

[Narwhal](https://arxiv.org/abs/2105.11827) and [Bullshark](https://arxiv.org/abs/2209.05633), are high-performant mempool and consensus engines by [Mysten Labs](https://github.com/MystenLabs). The Fleek Network uses Narwhal as a DAG-mempool for transaction ordering (as total ordering or linear order) and Bullshark as the consensus engine.

Expand Down Expand Up @@ -401,10 +400,3 @@ The Fleek Network binary process is the program that's been compiled down to mac
A JSON-RPC (JavaScript Object Notation Remote Procedure Call) is a protocol that enables communication between client and server applications. The [Fleek Network JSON-RPC](https://fleek-network.github.io/lightning/api-documentation/?202308171515) API enables JSON-RPC interaction with Fleek Network Node.

Fleek Network JSON-RPC API reference documentation is available at [https://fleek-network.github.io/lightning/api-documentation](https://fleek-network.github.io/lightning/api-documentation).

<Author
name="Helder Oliveira"
image="https://github.com/heldrida.png"
title="Software Developer + DX"
url="https://github.com/heldrida"
/>
8 changes: 0 additions & 8 deletions docs/node/analyzing-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ tags:
- diagnostic
---

import Author from '@site/src/components/Author';

## Analyzing Logs

Expand Down Expand Up @@ -86,10 +85,3 @@ In any case, you can use the Docker command to analyze the logs. If you have sti
sudo docker logs -f lightning-node
```
:::

<Author
name="Helder Oliveira"
image="https://github.com/heldrida.png"
title="Software Developer + DX"
url="https://github.com/heldrida"
/>
9 changes: 0 additions & 9 deletions docs/node/health-check.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ tags:
- node status
---

import Author from '@site/src/components/Author';

## TL;DR: Run the command

A script is available to do and provide a health check overview:
Expand Down Expand Up @@ -104,10 +102,3 @@ If the request is successful, you should get the result `pong` as follows:
```

Any other response, such as errors determine that the node is not healthy.

<Author
name="Helder Oliveira"
image="https://github.com/heldrida.png"
title="Software Developer + DX"
url="https://github.com/heldrida"
/>
15 changes: 3 additions & 12 deletions docs/node/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,16 @@ tags:
- build
---

import Author from '@site/src/components/Author';

## Overview

This section provides instructions to help you build a **Fleek Network Node**, it's aimed at everybody willing to learn and cultivate knowledge as a [node operator](#node-operator).
This section provides instructions to help you build a **Fleek Network Node**, it's aimed at everybody willing to learn and cultivate knowledge as a node operator.

:::tip
To participate in the [alpha Testnet](/docs/roadmap), you can begin by setting up and running nodes. Check the [requirements](/docs/node/requirements) and find the [onboarding instructions](/docs/node/testnet-onboarding) to enable you to [install](/docs/node/install) a network node successfully.
:::

# Node operator
## Node operator {#node-operator}

---

A **Node Operator** is represented as a system administrator who builds, installs or maintains one or many nodes in a server or more.
Expand All @@ -40,11 +39,3 @@ While we do our best to provide the clearest instructions, there's always space
:::

**Ready?** Start by checking the [server requirements](/docs/node/requirements)


<Author
name="Helder Oliveira"
image="https://github.com/heldrida.png"
title="Software Developer + DX"
url="https://github.com/heldrida"
/>
14 changes: 3 additions & 11 deletions docs/node/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ tags:
- manual
---

import Author from '@site/src/components/Author';
import GitCloneOptions from '../../guides/partials/_git-clone-options.mdx';
import CreateAUser from '../../guides/partials/_create-a-user.mdx';
import SetUserPathInConfigToml from '../../guides/partials/_set-user-path-config-toml.mdx';
Expand All @@ -31,7 +30,7 @@ This section describes how to install the Fleek Network Lightning on supported o
If you'd like to participate in the [alpha Testnet](/docs/roadmap), you have to go through the onboarding process. Check the [requirements](/docs/node/requirements) and find the [onboarding instructions](/docs/node/testnet-onboarding) to enable you to proceed and [install](/docs/node/install) a network node successfully.
:::

## Assisted installer
## Assisted installer {#assisted-installer}

The assisted installer is a script written in [Bash](https://en.wikipedia.org/wiki/Bash_(Unix_shell)) (Unix shell) that is available as a curl command line.

Expand Down Expand Up @@ -118,7 +117,7 @@ sudo systemctl start lightning.service
```

:::tip
To learn more about Systemctl commands, visit the section [Use Systemctl to manage the Lightning Service](#use-systemctl-to-manage-systemd-service)
To learn more about Systemctl commands, visit the section [Use Systemctl to manage the Lightning Service](/docs/node/systemd-service/#use-systemctl-to-manage-systemd-service)
:::

:::tip
Expand Down Expand Up @@ -569,7 +568,7 @@ sudo systemctl start lightning.service
Find the timeline of events for the Lightning service by checking the log files. Learn about it in the section [Log Messages](/docs/node/analyzing-logs).
:::

To learn more, visit the section [Use Systemctl to manage the Lightning Service](#use-systemctl-to-manage-systemd-service)
To learn more, visit the section [Use Systemctl to manage the Lightning Service](/docs/node/systemd-service/#use-systemctl-to-manage-systemd-service)

## Docker installation

Expand Down Expand Up @@ -708,10 +707,3 @@ Learn how to manage the Systemd Service by reading the section [systemd service]
## Frequently Used Commands (Quick Reference)

A quick reference of the most Frequently Used Commands are available for [Native](/references/Lightning%20CLI/frequently-used-commands-for-native-setup) and [Docker](/references/Docker/frequently-used-commands-for-docker-setup) setups. If you'd like a more in depth explanation of the commands, check the [health check](/docs/node/health-check), [analyzing logs](/docs/node/analyzing-logs), [systemd service](/docs/node/systemd-service) and [guides](/guides) sections separately.

<Author
name="Helder Oliveira"
image="https://github.com/heldrida.png"
title="Software Developer + DX"
url="https://github.com/heldrida"
/>
8 changes: 0 additions & 8 deletions docs/node/lightning-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ tags:
- lgtn
---

import Author from '@site/src/components/Author';
import InfoNetworkParticipation from '../../guides/partials/_info_network_participation.mdx';
import TipShutdownGracefully from '../../guides/partials/_tip_shutdown_gracefully.mdx';
import WarningPreventPrematureShutdown from '../../guides/partials/_warning_prevent_premature_shutdown.mdx';
Expand Down Expand Up @@ -167,10 +166,3 @@ Options:
-v... Increases the level of verbosity (the max level is -vvv)
-h, --help Print help
```

<Author
name="Helder Oliveira"
image="https://github.com/heldrida.png"
title="Software Developer + DX"
url="https://github.com/heldrida"
/>
8 changes: 0 additions & 8 deletions docs/node/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ tags:
sidebarCollapsible: false
---

import Author from '@site/src/components/Author';
import Ports from '../../guides/partials/_ports.mdx';

## Requirements
Expand Down Expand Up @@ -57,10 +56,3 @@ The recommended number of CPU cores is a minimum of 4 with a minimum CPU speed o
### Memory

A minimum of 32 GB of memory (RAM) is required and a reasonable amount of disk space for the installation and running processes, which at the minimum should be around 20 GB.

<Author
name="Helder Oliveira"
image="https://github.com/heldrida.png"
title="Software Developer + DX"
url="https://github.com/heldrida"
/>
12 changes: 2 additions & 10 deletions docs/node/systemd-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,15 @@ tags:
- manage
---

import Author from '@site/src/components/Author';
import WarningPreventPrematureShutdown from '../../guides/partials/_warning_prevent_premature_shutdown.mdx';
import TipShutdownGracefully from '../../guides/partials/_tip_shutdown_gracefully.mdx';
import InfoNetworkParticipation from '../../guides/partials/_info_network_participation.mdx';

## Systemd Service
## Systemd Service {#use-systemctl-to-manage-systemd-service}

In this section we describe how to enable, disable, start, stop the Systemd Service.

The service is set up by the [assisted installer](#assisted-installer) automatically, or manually as described in the [manual installation](/docs/node/install#manual-installation) and [docker install](/docs/node/install#docker-installation).
The service is set up by the [assisted installer](/docs/node/install#assisted-installer) automatically, or manually as described in the [manual installation](/docs/node/install#manual-installation) and [docker install](/docs/node/install#docker-installation).

:::info
While the Lightning-CLI Node process can operate independently, it is recommended to utilize Systemd for service management of the Lightning Node process in Linux. It's important to note that any network-related settings, such as opting-in or opting-out of network participation, should be managed separately by the Node Operator via the [CLI](/docs/node/lightning-cli).
Expand Down Expand Up @@ -156,10 +155,3 @@ If you have installed or set up the Service as a Docker Container, prefix the se
sudo systemctl status docker-lightning
```
:::

<Author
name="Helder Oliveira"
image="https://github.com/heldrida.png"
title="Software Developer + DX"
url="https://github.com/heldrida"
/>
8 changes: 0 additions & 8 deletions docs/node/testnet-onboarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ tags:
sidebarCollapsible: false
---

import Author from '@site/src/components/Author';
import InfoNetworkParticipation from '../../guides/partials/_info_network_participation.mdx';

:::warning
Expand Down Expand Up @@ -184,10 +183,3 @@ However, if you wish to learn about key management, you can refer to the [instru
### Does Nodes require to have SGX chips?

Phase {4} testnet includes enhancements that require node features, such as [SGX chips](https://en.wikipedia.org/wiki/Software_Guard_Extensions). This enhances the network's capabilities and expands its service and use cases, as described in the [Genesis Node Operator Application](https://blog.fleek.network/post/genesis-node-operator-application/). For more information check the [following list of hardware](https://github.com/ayeks/SGX-hardware) which supports Intel SGX - Software Guard Extensions.

<Author
name="Helder Oliveira"
image="https://github.com/heldrida.png"
title="Software Developer + DX"
url="https://github.com/heldrida"
/>
Loading