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

Update docusaurus.config.js #658

Merged
merged 5 commits into from
Jul 1, 2022
Merged
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
8 changes: 8 additions & 0 deletions docs/stake-pool-guide/best-practices.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
id: best-practices
title: Best Practices
sidebar_label: Best Practices
description: best-practices
image: ../img/og-developer-portal.png
---
...coming soon
9 changes: 9 additions & 0 deletions docs/stake-pool-guide/install-configure-node.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
id: install-configure-node
title: Install and Configure Node
sidebar_label: Install & Configure Node
description: install-configure-node
image: ../img/og-developer-portal.png
---
...coming soon

39 changes: 39 additions & 0 deletions docs/stake-pool-guide/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
id: introduction
slug: /stake-pool-guide/
title: Introduction to Stake Pools
sidebar_label: Introduction
description: Introduction
image: ../img/og-developer-portal.png
---

![Cardano Operate a Stake Pool](../../static/img/card-operate-a-stake-pool-title.svg)

There are excellent guidelines available on how to set up cardano-node as a stake pool. You may even set one up without any prior Linux experience or concern for best practices. Simply copy and paste the commands from the instructions into your shell.

Unfortunately, simply getting your node up and running is insufficient. You must be able to manage, update, and safeguard it. To do so, you must first comprehend what you are doing.

After you've mastered these fundamentals, you'll need to market your stake pool effectively in order to make it a success.

## What are the prerequisites for persons who wish to learn how to run a stake pool?
- Knowledge of how to manage a server. You must be familiar with the operating system of your choosing in order to administer, maintain, and secure your server.
- This includes a thorough understanding of how networks operate, as well as how to backup and restore data.
- Experienced in interpreting documentation and implementing best practices
- Understand Cardano, blockchain, wallets, and key pairs on a fundamental level.

## What if I don't meet the requirements?
If you don't meet all of the qualifications, you'll need a strong desire to study and the understanding that you won't be able to learn everything in a few weeks.

We observed people who had no prior knowledge of Linux, shells, or networking, but who were committed and had enough time to properly deal with it, and who now manage a profitable stake pool. It isn't for everyone, and it isn't going to be simple. Here are a few resources to get you started:
- [Start playing around with Linux](https://ubuntu.com/tutorials/command-line-for-beginners#1-overview).
- [Have a look at nix and NixOS](https://nixos.org).
- [Choose security over comfort](#choose-security-over-comfort).
- [Complete the stake pool course](#stake-pool-course).
- [Stake pool operator forum](https://forum.cardano.org/c/staking-delegation/156).

## Choose security over comfort
Best procedures should always be a key consideration when running a stake pool. Security isn't something you can turn on or off or change in a configuration file. It is both an attitude and a way of life.
- [Discuss security related topics with stake pool operators](https://forum.cardano.org/c/staking-delegation/stake-pool-security/157).

Learn which keys are available, which are hot and sensitive, and which you should never save on a server, no matter how convenient it is.
- [Read about Cardano key pairs](cardano-key-pairs).
9 changes: 9 additions & 0 deletions docs/stake-pool-guide/pool-maintainance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
id: pool-maintainance
title: Pool Maintainance
sidebar_label: Pool Maintainance
description: pool maintainance
image: ../img/og-developer-portal.png
---
...coming soon

8 changes: 8 additions & 0 deletions docs/stake-pool-guide/pre-requisites.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
id: pre-requisites
title: Pre-requisites
sidebar_label: Pre-requisites
description: pre-requisites
image: ../img/og-developer-portal.png
---
...coming soon
8 changes: 8 additions & 0 deletions docs/stake-pool-guide/register-pool.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
id: register-pool
title: Register Pool
sidebar_label: Register Pool
description: register-pool
image: ../img/og-developer-portal.png
---
...coming soon
8 changes: 8 additions & 0 deletions docs/stake-pool-guide/tools-links.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
id: tools-links
title: Tools Links
sidebar_label: Tools Links
description: tools-links
image: ../img/og-developer-portal.png
---
...coming soon
10 changes: 5 additions & 5 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,11 @@ module.exports = {
},

items: [
{
to: "docs/get-started/",
label: "Get Started",
position: "left",
},
{
to: "tools",
label: "Builder Tools",
Expand All @@ -71,11 +76,6 @@ module.exports = {
label: "Showcase",
position: "left",
},
{
to: "docs/get-started/testnets-and-devnets",
label: "Testnets",
position: "left",
},
{
to: "blog/",
label: "Dev Blog",
Expand Down
9 changes: 9 additions & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,15 @@ module.exports = {
},
"operate-a-stake-pool/marketing-stake-pool",
],
"Stake Pool Guide": [
"stake-pool-guide/introduction",
"stake-pool-guide/pre-requisites",
"stake-pool-guide/install-configure-node",
"stake-pool-guide/register-pool",
"stake-pool-guide/pool-maintainance",
"stake-pool-guide/tools-links",
sanskys marked this conversation as resolved.
Show resolved Hide resolved
"stake-pool-guide/best-practices",
],
"Contribute to the Developer Portal": [
"portal-contributors",
"portal-contribute",
Expand Down