Skip to content

Commit

Permalink
docs: 📝 add network participation partial to Lightning CLI
Browse files Browse the repository at this point in the history
  • Loading branch information
heldrida committed Jan 19, 2024
1 parent 246abd0 commit 826b932
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
5 changes: 2 additions & 3 deletions docs/node/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ 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';
import NoteExecStartFlagCConfigPath from '../../guides/partials/_note_execstart-flag-c-config-path.mdx';
import InfoNetworkParticipation from '../../guides/partials/_info_network_participation.mdx';

This section describes how to install the Fleek Network Lightning on supported operating systems. The installation can be made quicker by running the [assisted installer](#assisted-installer) or by following the [manual installation](#manual-installation) if you want a bit more control.

Expand Down Expand Up @@ -454,9 +455,7 @@ The configuration file should have more content, which was omitted here to keep
The Node Operator has to explicitly opt-in for a node to participate in the Network, regardless of whether the node Lightning Service is running.
:::info
Node participation in an Epoch can be true or false (online or offline). Participation is transient when the operator requests to opt in or out, and the network has yet to end the Epoch. Once the Epoch ends, it transitions to true or false. Therefore, a Node Operator can expect a Node state to be online, offline, opted in or out during an Epoch lifetime.
:::
<InfoNetworkParticipation />
Amongst other motives, the ability to control if a node participates in the Network gives the operator a chance to shut it down gracefully at the end of the Epoch without incurring reputation penalties. For example, a node that opted in should actively participate, not down and unresponsive.
Expand Down
3 changes: 3 additions & 0 deletions docs/node/lightning-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ tags:
---

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

The Lightning CLI provides a wide range of capabilities, including running the node, accessing key management utilities, network participation management and printing the loaded configuration.

Expand Down Expand Up @@ -68,6 +69,8 @@ The \<USERNAME\> is a placeholder for the actual system username. So, make sure

The Opt command allows the user to opt into or out of Network participation.

<InfoNetworkParticipation />

To opt-in, use the subcommand **in**:

```sh
Expand Down

0 comments on commit 826b932

Please sign in to comment.