Merge branch 'release/0.1.0-beta.3'

realfish · realfish · commit f1cef46cf9c7 · 2023-10-14T15:17:16.000+08:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,9 +1,31 @@
 # CHANGELOG
 
-## [0.1.0-beta.2][0.1.0-beta.2] · 2023-10-04
+## [0.1.0-beta.3][0.1.0-beta.3] · 2023-10-14
 
 ### Added
 
+- Feat: Dora Vota DevOps Guide.
+
+### Changed
+
+- Feat: Refine title gradient color for auto-generated OG images.
+- Build: Update deps to latest versions.
+  - `nextra`: 2.13.2
+  - `nextra-theme-docs`: 2.13.2
+- Build: Update devDeps to latest versions.
+  - `@types/node`: 20.8.6
+  - `@types/react`: 18.2.28
+  - `eslint`: 8.51.0
+  - `sass`: 1.69.3
+  - `prettier-plugin-tailwindcss`: 0.5.6
+
+### Fixed
+
+- Fix: Fix a typo in Vota Operator Manual.
+- Fix: Fix a link in Vota Developer Guide.
+
+## [0.1.0-beta.2][0.1.0-beta.2] · 2023-10-04
+
 ### Changed
 
 - Refactor: Prefix `SITE_ROOT` with `NEXT_PUBLIC_` to streamline environment variable configuration.
@@ -94,6 +116,7 @@
 - Docs: [Code of Conduct](CODE_OF_CONDUCT.md), based on [Contributor Covenant](https://www.contributor-covenant.org) v2.1.
 - Chore: Configure GitHub [Dependabot](.github/dependabot.yml).
 
+[0.1.0-beta.3]: https://github.com/DoraFactory/df-docs/compare/0.1.0-beta.2...0.1.0-beta.3
 [0.1.0-beta.2]: https://github.com/DoraFactory/df-docs/compare/0.1.0-beta.1...0.1.0-beta.2
 [0.1.0-beta.1]: https://github.com/DoraFactory/df-docs/compare/0.1.0-beta...0.1.0-beta.1
 [0.1.0-beta]: https://github.com/DoraFactory/df-docs/compare/0.1.0-alpha...0.1.0-beta
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-vota@dorafactory.org.
+support@dorafactory.org.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the
diff --git a/components/svgs/icon-node.svg b/components/svgs/icon-node.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" height="24" viewBox="0 -960 960 960" width="24"><path fill="currentColor" d="M120-160v-120q0-33 23.5-56.5T200-360h40v-80q0-33 23.5-56.5T320-520h120v-80h-40q-33 0-56.5-23.5T320-680v-120q0-33 23.5-56.5T400-880h160q33 0 56.5 23.5T640-800v120q0 33-23.5 56.5T560-600h-40v80h120q33 0 56.5 23.5T720-440v80h40q33 0 56.5 23.5T840-280v120q0 33-23.5 56.5T760-80H600q-33 0-56.5-23.5T520-160v-120q0-33 23.5-56.5T600-360h40v-80H320v80h40q33 0 56.5 23.5T440-280v120q0 33-23.5 56.5T360-80H200q-33 0-56.5-23.5T120-160Zm280-520h160v-120H400v120ZM200-160h160v-120H200v120Zm400 0h160v-120H600v120ZM480-680ZM360-280Zm240 0Z"/></svg>
diff --git a/components/svgs/index.ts b/components/svgs/index.ts
@@ -5,4 +5,5 @@ export { default as IconCli } from './icon-cli.svg'
 export { default as IconCode } from './icon-code.svg'
 export { default as IconGui } from './icon-gui.svg'
 export { default as IconHelp } from './icon-help.svg'
+export { default as IconNode } from './icon-node.svg'
 export { default as IconReference } from './icon-reference.svg'
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "df-docs",
-  "version": "0.1.0-beta.2",
+  "version": "0.1.0-beta.3",
   "private": true,
   "scripts": {
     "build": "next build",
@@ -13,23 +13,23 @@
   "dependencies": {
     "@vercel/og": "^0.5.17",
     "next": "^13.5.4",
-    "nextra": "^2.13.1",
-    "nextra-theme-docs": "^2.13.1",
+    "nextra": "^2.13.2",
+    "nextra-theme-docs": "^2.13.2",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },
   "devDependencies": {
     "@svgr/webpack": "^8.1.0",
-    "@types/node": "20.8.2",
-    "@types/react": "^18.2.24",
+    "@types/node": "20.8.6",
+    "@types/react": "^18.2.28",
     "autoprefixer": "^10.4.16",
-    "eslint": "8.50.0",
+    "eslint": "8.51.0",
     "eslint-config-next": "13.5.4",
     "postcss": "^8.4.31",
     "prettier": "3.0.3",
     "prettier-plugin-pkg": "0.18.0",
-    "prettier-plugin-tailwindcss": "0.5.5",
-    "sass": "^1.68.0",
+    "prettier-plugin-tailwindcss": "0.5.6",
+    "sass": "^1.69.3",
     "tailwindcss": "^3.3.3",
     "typescript": "5.2.2"
   }
diff --git a/pages/api/og.tsx b/pages/api/og.tsx
@@ -98,6 +98,7 @@ export default async function handler(request: NextRequest) {
           >
             <div
               style={{
+                display: 'flex',
                 color: 'rgba(0, 0, 0, 0)',
                 fontFamily: '"Public Sans"',
                 fontSize: '54px',
@@ -106,7 +107,7 @@ export default async function handler(request: NextRequest) {
                 // textWrap: 'wrap',
                 backgroundClip: 'text',
                 backgroundImage:
-                  'linear-gradient(72deg, rgba(255, 255, 255, 0.75) 0%, rgba(255, 255, 255, 0.98) 100%)'
+                  'linear-gradient(72deg, rgba(255, 255, 255, 0.8) 0%, rgba(255, 255, 255, 0.98) 50%)'
               }}
             >
               {title}
diff --git a/pages/docs/_meta.json b/pages/docs/_meta.json
@@ -7,6 +7,7 @@
   },
   "vota": "Vota Operator Manual",
   "vota-dev": "Vota Developer Guide",
+  "vota-devops": "Vota DevOps Guide",
 
   "-- references": {
     "type": "separator",
diff --git a/pages/docs/index.mdx b/pages/docs/index.mdx
@@ -24,6 +24,11 @@ export const CARD_COPY = [
     desc: 'This beginner-friendly guide is intended to help you get started with Dora Vota and build on it.',
     url: '/docs/vota-dev'
   },
+  {
+    title: 'Dora Vota DevOps Guide',
+    desc: 'This guide provides instructions on running a Dora Vota full node and setting up as a validator. It covers hardware requirements, port and chain configurations, and the process of starting a node and registering as a validator. Ensure your environment meets all requirements to operate Dora Vota nodes successfully.',
+    url: '/docs/vota-devops'
+  },
   // {
   //   title: 'Aptos APIs',
   //   desc: 'Dora Factory offers a set of Aptos APIs for hackers, developers, and teams working on Aptos native applications. More APIs will be added over time.',
diff --git a/pages/docs/vota-dev/resources.mdx b/pages/docs/vota-dev/resources.mdx
@@ -15,7 +15,7 @@ We have now launched the Dora Vota Mainnet, identified with the chain-id: `vota-
 
 ## Genesis files
 
-You can find the genesis file of the Mainnet `vota-ash` from our [GitHub repo](https://github.com/DoraFactory/doravota/blob/main/config/genesis.json).
+You can find the genesis file of the Mainnet `vota-ash` from our [GitHub repo](https://github.com/DoraFactory/doravota/blob/main/config/mainnet/genesis.json).
 
 ## Endpoints
 
diff --git a/pages/docs/vota-devops.mdx b/pages/docs/vota-devops.mdx
@@ -0,0 +1,35 @@
+---
+title: 'Dora Vota DevOps Guide'
+desc: 'This guide provides instructions on running a Dora Vota full node and setting up as a validator. It covers hardware requirements, port and chain configurations, and the process of starting a node and registering as a validator. Ensure your environment meets all requirements to operate Dora Vota nodes successfully.'
+---
+
+import { Cards } from 'nextra/components'
+import {
+  IconChecklist,
+  IconCli,
+  IconCode,
+  IconHelp,
+  IconNode,
+  IconReference
+} from '@components/svgs'
+
+# Dora Vota DevOps Guide
+
+This guide provides instructions on running a Dora Vota full node and setting up as a validator.
+
+It covers hardware requirements, port and chain configurations, and the process of starting a node and registering as a validator. Ensure your environment meets all requirements to operate Dora Vota nodes successfully.
+
+---
+
+<Cards num={2}>
+  <Cards.Card
+    icon={<IconCli />}
+    title="Run a Full Node"
+    href="/docs/vota-devops/node"
+  />
+  <Cards.Card
+    icon={<IconNode />}
+    title="Run a Validator"
+    href="/docs/vota-devops/validator"
+  />
+</Cards>
diff --git a/pages/docs/vota-devops/_meta.json b/pages/docs/vota-devops/_meta.json
@@ -0,0 +1,4 @@
+{
+  "node": "Run a Full Node",
+  "validator": "Run a Validator"
+}
diff --git a/pages/docs/vota-devops/node.mdx b/pages/docs/vota-devops/node.mdx
@@ -0,0 +1,148 @@
+---
+title: 'Run a Full Node · Dora Vota DevOps Guide'
+desc: 'This guide provides instructions on running a Dora Vota full node and setting up as a validator. It covers hardware requirements, port and chain configurations, and the process of starting a node and registering as a validator. Ensure your environment meets all requirements to operate Dora Vota nodes successfully.'
+---
+
+import { Callout, FileTree, Steps, Tabs } from 'nextra/components'
+
+# Run a Full Node
+
+A Dora Vota full node consists of a local copy of the entire blockchain, including its block history and states. Running a full node is essential for participating in network operations like validating transactions, joining consensus, and broadcasting events to other network participants.
+
+In this guide, we will walk you through the process of setting up and running a Dora Vota full node.
+
+## Node configurations
+
+### Hardware requirements
+
+Below is the recommended hardware configuration for running a Dora Vota full node.
+
+| Chain ID | CPU     | RAM  | Disk     |
+| :------- | :------ | :--- | :------- |
+| vota-ash | 4 cores | 16GB | 1TB NVME |
+
+### Commonly used ports
+
+`dorad` uses the following TCP ports. Toggle their settings to match your environment.
+
+- `26656`: The default port for P2P. This port is used to communicate with other nodes and must be open to join a network. However, it does not have to be open to the public. For validator nodes, configuring persistent_peers and closing this port to the public are recommended.
+
+Additional ports:
+
+- `1317`: The default port for interacting with the `dorad` API server for HTTP RESTful requests. This allows applications and services to interact with the dorad instance through RPC.
+- `26660`: The default port for interacting with the Prometheus database, which can be used to monitor the environment. In the default configuration, this port is not open.
+- `26657`: The default port for RPC. Because this port is used for querying and sending transactions, it must be open to serve queries from `dorad`.
+
+These ports are all customizable in `~/.dora/config/config.toml` and `~/.dora/config/app/toml`.
+
+### Configure chain settings
+
+The following information describes the most important node configuration settings found in the `~/.dora/config/` directory. This is the structure of `~/.dora/config`:
+
+<FileTree>
+  <FileTree.Folder name="~/.dora/config" defaultOpen>
+    <FileTree.File name="app.toml" />
+    <FileTree.File name="client.toml" />
+    <FileTree.File name="config.toml" />
+    <FileTree.File name="genesis.json" />
+    <FileTree.File name="node_key.json" />
+    <FileTree.File name="priv_validator_key.json" />
+  </FileTree.Folder>
+</FileTree>
+
+- `app.toml`: Configuration of `dorad`
+- `client.toml`: Configurations for the cli wallet (ex dorad)
+- `config.toml`: Tendermint configuration file
+- `genesis.json`: Gensesis transactions
+- `node_key.json`: Private key used for node authentication in the p2p protocol (its corresponding public key is the nodeid)
+- `priv_validator_key.json`: Key used by the validator on the node to sign blocks
+
+## Start a node
+
+To instate a Dora Vota node, the first step is to [download and install `dorad`](/docs/vota-dev/dorad) on your machine. Make sure you check out and install the same version as the chain you want to join.
+
+<Callout type="info">
+  A moniker is the custom username of your node. It should be human-readable.
+  It’s set at the time of node setup and can be used to provide a more
+  descriptive and friendly name to identify the node, as opposed to using an IP
+  address or a public key hash which can be hard to remember or recognize.
+</Callout>
+
+### Init commands
+
+```shell
+export VERSION=0.2.0
+export CHAIN_ID="vota-ash"
+export MONIKER="replace-with-your-moniker-name"
+
+git clone https://github.com/DoraFactory/doravota.git
+cd doravota && git checkout $VERSION
+make install
+dorad init --chain-id "$CHAIN_ID" "$MONIKER"
+
+sed -i -e "s|^minimum-gas-prices *=.*|minimum-gas-prices = \"100000000000peaka\"|" $HOME/.dora/config/app.toml
+```
+
+### Repalce genesis file
+
+Replace the genesis file in `~/.dora/config` with the [Dora Vota Mainnet genesis file](https://github.com/DoraFactory/doravota/blob/main/config/mainnet/genesis.json).
+
+## Configure to sync chain data
+
+Now that we have set up some peers, you can add them into `config.toml` to sync Dora Vota chain data.
+
+```shell
+# Comma separated list of seed nodes to connect to
+seeds = "55a1d7354f783b0983cf6ff5d13ca98f9eb611e3@54.254.158.153:26656,6c77c0ef2822a439837ad994ee0dccf6661b841c@54.151.160.200:26656"
+
+# Comma separated list of nodes to keep persistent connections to
+persistent_peers = "55a1d7354f783b0983cf6ff5d13ca98f9eb611e3@54.254.158.153:26656,6c77c0ef2822a439837ad994ee0dccf6661b841c@54.151.160.200:26656"
+```
+
+## Running `dorad` node service
+
+<Steps>
+### Register `dorad` as a `systemd` service
+
+`dorad` should be running at all times. It’s recommended you register `dorad` as a `systemd` service so that it will automatically restart if your system reboots.
+
+### Create the definition file
+
+Create the definition file in `/etc/systemd/system/dorad.service`.
+
+```shell
+[Unit]
+Description=dora-mainnet-vota-ash
+After=network-online.target
+
+[Service]
+User=<USER>
+ExecStart=<PATH_TO_DORAD>/dorad start
+RestartSec=10
+Restart=on-failure
+LimitNOFILE=655350
+
+[Install]
+WantedBy=multi-user.target
+```
+
+- `<USER>`: Enter the user (likely your username or root, unless you created a user specifically for `dorad`).
+- `<PATH_TO_DORAD>`: Enter the path to the `dorad` executable, which is likely `/home/<YOUR_USER>/go/bin/dorad` or `/usr/go/bin`. Confirm this by checking the location of `dorad`.
+
+### Run the program upon startup
+
+After registering `dorad` as a system service, you can set the program to run upon startup.
+
+```shell
+systemctl daemon-reload
+systemctl enable dorad
+```
+
+### Start the service and check the log
+
+```shell
+sudo systemctl start dorad
+sudo journalctl -u dorad -f --no-hostname -o cat
+```
+
+</Steps>
diff --git a/pages/docs/vota-devops/validator.mdx b/pages/docs/vota-devops/validator.mdx
diff --git a/pages/docs/vota/deploy.mdx b/pages/docs/vota/deploy.mdx
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
