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

[Docs] Move over docs from poktroll-docker-compose-example #757

Merged
merged 6 commits into from
Aug 25, 2024

Conversation

Olshansk
Copy link
Member

Summary

Make it easier to onboard users to Shannon by providing a nicer skin on the docs in poktroll-docker-compose-example

Also:

  • Improve ToC
  • Improve introduction
  • Add a results video

Screenshot 2024-08-23 at 11 23 38 AM

Type of change

Select one or more:

  • New feature, functionality or library
  • Bug fix
  • Code health or cleanup
  • Documentation
  • Other (specify)

Testing

  • Documentation: make docusaurus_start; only needed if you make doc changes
  • Unit Tests: make go_develop_and_test
  • LocalNet E2E Tests: make test_e2e
  • DevNet E2E Tests: Add the devnet-test-e2e label to the PR.

@Olshansk Olshansk added the documentation Improvements or additions to documentation label Aug 23, 2024
@Olshansk Olshansk requested a review from okdas August 23, 2024 15:24
@Olshansk Olshansk self-assigned this Aug 23, 2024
Copy link
Member

@okdas okdas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good. I looked through the docs quickly.

  1. Do you want me to try this on a fresh server on vultr?
  2. Do you think we should add the ufw rule we discovered last week (the one blocking connections from the appgate to relayminer on the same machine)?

```bash
poktrolld keys add supplier > /tmp/supplier

mnemonic=$(tail -n 1 /tmp/supplier | tr -d '\r'); sed -i "s|SUPPLIER_MNEMONIC=\".*\"|SUPPLIER_MNEMONIC=\"$mnemonic\"|" .env

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[linter-name (fail-on-found)] reported by reviewdog 🐶
mnemonic=$(tail -n 1 /tmp/supplier | tr -d '\r'); sed -i "s|SUPPLIER_MNEMONIC=".*"|SUPPLIER_MNEMONIC="$mnemonic"|" .env

```bash
poktrolld keys add application > /tmp/application

mnemonic=$(tail -n 1 /tmp/application | tr -d '\r'); sed -i "s|APPLICATION_MNEMONIC=\".*\"|APPLICATION_MNEMONIC=\"$mnemonic\"|" .env

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[linter-name (fail-on-found)] reported by reviewdog 🐶
mnemonic=$(tail -n 1 /tmp/application | tr -d '\r'); sed -i "s|APPLICATION_MNEMONIC=".*"|APPLICATION_MNEMONIC="$mnemonic"|" .env

```bash
poktrolld keys add gateway > /tmp/gateway

mnemonic=$(tail -n 1 /tmp/gateway | tr -d '\r'); sed -i "s|GATEWAY_MNEMONIC=\".*\"|GATEWAY_MNEMONIC=\"$mnemonic\"|" .env

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[linter-name (fail-on-found)] reported by reviewdog 🐶
mnemonic=$(tail -n 1 /tmp/gateway | tr -d '\r'); sed -i "s|GATEWAY_MNEMONIC=".*"|GATEWAY_MNEMONIC="$mnemonic"|" .env


```bash
sed -i -e s/YOUR_NODE_IP_OR_HOST/$NODE_HOSTNAME/g ./stake_configs/supplier_stake_config_example.yaml
sed -i -e s/YOUR_OWNER_ADDRESS/$SUPPLIER_ADDR/g ./stake_configs/supplier_stake_config_example.yaml

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[linter-name (fail-on-found)] reported by reviewdog 🐶
sed -i -e s/YOUR_OWNER_ADDRESS/$SUPPLIER_ADDR/g ./stake_configs/supplier_stake_config_example.yaml

@Olshansk
Copy link
Member Author

@okdas

Do you want me to try this on a fresh server on vultr?

Yes, would appreciate it.

Do you think we should add the ufw rule we discovered last week (the one blocking connections from the appgate to relayminer on the same machine)?

There's a lot more than that. Added things back.

@Olshansk Olshansk added this to the Shannon Beta TestNet Launch milestone Aug 23, 2024
@Olshansk
Copy link
Member Author

Olshansk commented Aug 25, 2024

Merging with sed error because it is expected given the fact that the cheatsheed is written for Debian specifically.

Screenshot 2024-08-25 at 1 02 16 PM

@Olshansk Olshansk merged commit b512745 into main Aug 25, 2024
12 of 13 checks passed
@Olshansk Olshansk deleted the move_over_poktroll_docs branch August 25, 2024 17:03
bryanchriswhite added a commit that referenced this pull request Aug 27, 2024
…ke-transfer

* pokt/main:
  [Application] Implement unbonding period (#735)
  [Docs] Move over docs from poktroll-docker-compose-example (#757)
  [Performance] Reduce RelayMiner memory consumption under load (#739)
okdas added a commit that referenced this pull request Nov 14, 2024
## Summary

Make it easier to onboard users to Shannon by providing a nicer skin on
the docs in
[poktroll-docker-compose-example](https://github.com/pokt-network/poktroll-docker-compose-example)

Also:
- Improve ToC
- Improve introduction
- Add a results video

![Screenshot 2024-08-23 at 11 23
38 AM](https://github.com/user-attachments/assets/a73b29f1-1fb3-4e35-a41b-b9c8a9f2d450)


---------

Co-authored-by: Dima K. <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants