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] Beta TestNet - Service Cheatsheet #965

Merged
merged 13 commits into from
Nov 26, 2024
Merged

[Docs] Beta TestNet - Service Cheatsheet #965

merged 13 commits into from
Nov 26, 2024

Conversation

Olshansk
Copy link
Member

@Olshansk Olshansk commented Nov 25, 2024

Summary

Cheatsheet to add a new onchain Service plus a few other improvements.

  • Add a service quickstart
  • Update .gitignore w/ a few config files
  • Add tl;dr to CLI installation and use account setup`
  • Add instructions on creating a new Debian user

Issue

Type of change

Select one or more from the following:

Testing

  • Testing things manually by following the instructions

@Olshansk Olshansk self-assigned this Nov 25, 2024
@Olshansk Olshansk added the documentation Improvements or additions to documentation label Nov 25, 2024
@Olshansk Olshansk added this to the Shannon Beta TestNet Launch milestone Nov 25, 2024
@Olshansk Olshansk marked this pull request as ready for review November 25, 2024 21:48
@Olshansk Olshansk changed the title [Docs] Service Cheatsheet [Docs] Beta TestNet - Service Cheatsheet Nov 25, 2024
@Olshansk
Copy link
Member Author

Olshansk commented Nov 25, 2024

@red-0ne @okdas

I ended up splitting Supplier CheatSheet and Service Cheatsheet into two as I started work on #947.

I think we should merge this in first.

Some asks as you review this:

  1. Not the types of tl;drs I'm adding
  2. Note that types of cross-references & pre-requisites I'm adding
  3. Please inspect ☝️ and provide your feedback

Our goals are to:

  1. Stay consistent across all our docs
  2. Make it easy for anyone to get running
  3. Account for everyone's short attention spans
  4. Have the right amount of cross-references; too many and too few are both bad

Looking forward to your feedback!

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.

Good, I like how concise it is.

docusaurus/docs/operate/quickstart/service_cheatsheet.md Outdated Show resolved Hide resolved
Copy link
Contributor

@red-0ne red-0ne left a comment

Choose a reason for hiding this comment

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

Minor change requests but otherwise LGTM.

Preemptively approving.

@Olshansk
Copy link
Member Author

Good, I like how concise it is.

@okdas Ty. Was hoping to use this as an example/baseline for other cheatsheets too.

Good, I like how concise it is.

@red-0ne Appreciate the improvement suggestions!

@Olshansk Olshansk merged commit afa7c86 into main Nov 26, 2024
11 of 12 checks passed
@Olshansk Olshansk deleted the service_cheasheet branch November 26, 2024 20:57
bryanchriswhite added a commit that referenced this pull request Dec 2, 2024
…_num_relays

* pokt/main:
  [Docs/Tools] Validator: support multiple networks + cheat sheet (#941)
  [Docs] Upgrade list (#928)
  [Docs] Beta TestNet - Service Cheatsheet (#965)
  Commit outdated proto files
  [Docs] adding params - fix gRPC status error code (#958)
  [Docs] Update links to RPC & explorers (#950)
  [Docs] Update documentation on installing the `poktrolld` CLI (#949)
bryanchriswhite added a commit that referenced this pull request Dec 2, 2024
…/params/global_inflation_per_claim

* todo_beta/refactor/supplier_staking_fee: (21 commits)
  chore: add localnet_config option to disable hot-reloading (#979)
  [Code Health] fix: tokenomics module gRPC return errors (#963)
  [Code Health] fix: supplier module gRPC return errors (#962)
  [Supplier] feat: add `staking_fee` param to supplier module (#944)
  [Code Health] fix: application module gRPC status error returns (#954)
  [Code Health] fix: shared module gRPC return errors (#961)
  [Code Health] fix: session module gRPC status return errors (#960)
  [Code Health] fix: service module gRPC status error returns (#959)
  [Code Health] fix: proof module gRPC status error returns (#956)
  [Code Health] fix: gateway module gRPC status error returns (#955)
  [Tokenomics] feat: add `target_num_relays` param to service module (#930)
  chore: review feedback improvements
  chore: review feedback improvements
  [Docs/Tools] Validator: support multiple networks + cheat sheet (#941)
  [Docs] Upgrade list (#928)
  [Service] refactor: `TargetNumRelays` var usage to param usage (#943)
  [Docs] Beta TestNet - Service Cheatsheet (#965)
  Commit outdated proto files
  [Docs] adding params - fix gRPC status error code (#958)
  [Docs] Update links to RPC & explorers (#950)
  ...
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.

3 participants