From abe7b3a6eddde4f0c3d173f25d5b6cfb5bb08c7a Mon Sep 17 00:00:00 2001 From: Marius Poke Date: Mon, 5 Aug 2024 15:59:09 +0200 Subject: [PATCH] docs: update socials (#3252) * update socials * remove link to ibc specs * fix broken links --------- Co-authored-by: MSalopek --- docs/docs/delegators/delegator-faq.md | 2 +- docs/docs/getting-started/README.md | 2 +- docs/docs/hub-tutorials/join-mainnet.md | 10 +++--- docs/docs/validators/README.md | 2 +- docs/docs/validators/validator-faq.md | 2 +- docs/docusaurus.config.js | 42 ++++++++++++------------- 6 files changed, 29 insertions(+), 31 deletions(-) diff --git a/docs/docs/delegators/delegator-faq.md b/docs/docs/delegators/delegator-faq.md index d53fd575590..dfa94910654 100644 --- a/docs/docs/delegators/delegator-faq.md +++ b/docs/docs/delegators/delegator-faq.md @@ -5,7 +5,7 @@ order: 4 ## What is a delegator? -People that cannot or do not want to operate [validator nodes](../validators/overview.mdx) can still participate in the staking process as delegators. Indeed, validators are not chosen based on their self-delegated stake but based on their total stake, which is the sum of their self-delegated stake and of the stake that is delegated to them. This is an important property, as it makes delegators a safeguard against validators that exhibit bad behavior. If a validator misbehaves, their delegators will move their Atoms away from them, thereby reducing their stake. Eventually, if a validator's stake falls under the top 180 addresses with highest stake, they will exit the validator set. +People that cannot or do not want to operate [validator nodes](../validators/overview.md) can still participate in the staking process as delegators. Indeed, validators are not chosen based on their self-delegated stake but based on their total stake, which is the sum of their self-delegated stake and of the stake that is delegated to them. This is an important property, as it makes delegators a safeguard against validators that exhibit bad behavior. If a validator misbehaves, their delegators will move their Atoms away from them, thereby reducing their stake. Eventually, if a validator's stake falls under the top 180 addresses with highest stake, they will exit the validator set. **Delegators share the revenue of their validators, but they also share the risks.** In terms of revenue, validators and delegators differ in that validators can apply a commission on the revenue that goes to their delegator before it is distributed. This commission is known to delegators beforehand and can only change according to predefined constraints (see [section](#choosing-a-validator) below). In terms of risk, delegators' Atoms can be slashed if their validator misbehaves. For more, see [Risks](#risks) section. diff --git a/docs/docs/getting-started/README.md b/docs/docs/getting-started/README.md index a9a175263b6..0a041fb7b5a 100644 --- a/docs/docs/getting-started/README.md +++ b/docs/docs/getting-started/README.md @@ -7,4 +7,4 @@ This folder contains tutorials related to the `gaia` application. - [What is Gaia?](./what-is-gaia.md) - [Installing `gaiad`](./installation.md) -- [Joining Mainnet](./quickstart.mdx) +- [Joining Mainnet](./quickstart.md) diff --git a/docs/docs/hub-tutorials/join-mainnet.md b/docs/docs/hub-tutorials/join-mainnet.md index fe33efc6271..b461af4087b 100644 --- a/docs/docs/hub-tutorials/join-mainnet.md +++ b/docs/docs/hub-tutorials/join-mainnet.md @@ -29,16 +29,15 @@ The chain-id of Cosmos Hub mainnet is `cosmoshub-4`. **This guide includes full instructions for joining the mainnet either as an archive/full node or a pruned node.** -For instructions to bootstrap a node via Quicksync or State Sync, see the [Quickstart Guide](../getting-started/quickstart.mdx) +For instructions to bootstrap a node via Quicksync or State Sync, see the [Quickstart Guide](../getting-started/quickstart.md) -For instructions to join as a validator, please also see the [Validator Guide](../validators/overview.mdx). +For instructions to join as a validator, please also see the [Validator Guide](../validators/overview.md). ### Overview - [Join the Cosmos Hub Mainnet](#join-the-cosmos-hub-mainnet) - - [Release History](#release-history) + - [Release History](#release-history) - [Overview](#overview) - - [Background](#background) - [Explorers](#explorers) - [Getting Started](#getting-started) - [Hardware](#hardware) @@ -56,7 +55,6 @@ For instructions to join as a validator, please also see the [Validator Guide](. - [State Sync](#state-sync) - [Quicksync](#quicksync) - [Snapshots](#snapshots) - - [Releases \& Upgrades](#releases--upgrades) - [Cosmovisor](#cosmovisor) - [Running via Background Process](#running-via-background-process) - [Exporting State](#exporting-state) @@ -242,7 +240,7 @@ address = "0.0.0.0:9090" ## Sync Options -There are three main ways to sync a node on the Cosmos Hub; Blocksync, State Sync, and Quicksync. See the matrix below for the Hub's recommended setup configuration. This guide will focus on syncing two types of common nodes; full and pruned. For further information on syncing to run a validator node, see the section on [Validators](../validators/overview.mdx). +There are three main ways to sync a node on the Cosmos Hub; Blocksync, State Sync, and Quicksync. See the matrix below for the Hub's recommended setup configuration. This guide will focus on syncing two types of common nodes; full and pruned. For further information on syncing to run a validator node, see the section on [Validators](../validators/overview.md). There are two types of concerns when deciding which sync option is right. _Data integrity_ refers to how reliable the data provided by a subset of network participants is. _Historical data_ refers to how robust and inclusive the chain’s history is. diff --git a/docs/docs/validators/README.md b/docs/docs/validators/README.md index 578b9bf7a1d..a01a73e835a 100644 --- a/docs/docs/validators/README.md +++ b/docs/docs/validators/README.md @@ -5,7 +5,7 @@ order: 1 This folder contains documentation relevant to validators of the Cosmos Hub and other `gaia` blockchains. -- [Validator Overview](./overview.mdx) +- [Validator Overview](./overview.md) - [Setting Up a Validator for Cosmos Hub Mainnet](./validator-setup.md) - [Validator FAQ](./validator-faq.md) - [Validator Security Notice](./security.md) diff --git a/docs/docs/validators/validator-faq.md b/docs/docs/validators/validator-faq.md index 9829c8a5238..15c8048dbf3 100644 --- a/docs/docs/validators/validator-faq.md +++ b/docs/docs/validators/validator-faq.md @@ -327,7 +327,7 @@ Running an effective operation is key to avoiding unexpected unbonding or slashi Validators are expected to perform regular software updates to accommodate chain upgrades and bug fixes. It is suggested to consider using [Cosmovisor](https://docs.cosmos.network/v0.45/run-node/cosmovisor.html) to partially automate this process. -During an chain upgrade, progress is discussed in a private channel in the [Interchain Discord](https://discord.gg/cosmosnetwork). If your validator is in the active set we encourage you to request access to that channel by contacting a moderator. +During an chain upgrade, progress is discussed in a private channel in the [Interchain Discord](https://discord.gg/interchain). If your validator is in the active set we encourage you to request access to that channel by contacting a moderator. ### How can validators protect themselves from denial-of-service attacks? diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 3c4ff47f02a..2f0384182f7 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -121,20 +121,24 @@ const config = { html: ' Github', }, { - href: "https://reddit.com/r/cosmosnetwork", - html: ' Reddit', - }, - { - href: "https://www.youtube.com/c/CosmosProject", - html: ' YouTube', + href: "https://twitter.com/cosmoshub", + html: ' Twitter', }, { - href: "https://discord.gg/cosmosnetwork", + href: "https://discord.gg/interchain", html: ' Discord', }, { href: "https://forum.cosmos.network/", - html: ' Cosmos Forums', + html: ' Forum', + }, + { + href: "https://reddit.com/r/cosmosnetwork", + html: ' Reddit', + }, + { + href: "https://www.youtube.com/c/CosmosProject", + html: ' YouTube', }, ], }, @@ -174,43 +178,39 @@ const config = { href: "https://docs.cometbft.com/", }, { - label: "IBC Specs", - href: "https://github.com/cosmos/ibc", + label: "IBC-Go", + href: "https://ibc.cosmos.network/", }, { - label: "IBC Go", - href: "https://ibc.cosmos.network/", + label: "Interchain Security", + href: "https://cosmos.github.io/interchain-security/", }, ], }, { title: "Community", items: [ - { - label: "Blog", - href: "https://blog.cosmos.network/", - }, { label: "Forum", href: "https://forum.cosmos.network/", }, { label: "Discord", - href: "https://discord.gg/cosmosnetwork", + href: "https://discord.gg/interchain", }, { label: "Reddit", href: "https://reddit.com/r/cosmosnetwork", }, + { + label: "Blog", + href: "https://blog.cosmos.network/", + }, ], }, { title: "Social", items: [ - { - label: "Discord", - href: "https://discord.gg/cosmosnetwork", - }, { label: "Twitter", href: "https://twitter.com/cosmoshub",