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] Update Quickstart guide to onboard new devs #501

Merged
merged 11 commits into from
May 9, 2024
Merged

Conversation

Olshansk
Copy link
Member

Summary

Update the Quickstar guide to enable anyone to start developing on LocalNet quickly.

Issue

Type of change

Select one or more:

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

Testing

Documentation changes (only if making doc changes)

  • make docusaurus_start; only needed if you make doc changes

Local Testing (only if making code changes)

  • Unit Tests: make go_develop_and_test
  • LocalNet E2E Tests: make test_e2e
  • See quickstart guide for instructions

PR Testing (only if making code changes)

  • DevNet E2E Tests: Add the devnet-test-e2e label to the PR.
    • THIS IS VERY EXPENSIVE, so only do it after all the reviews are complete.
    • Optionally run make trigger_ci if you want to re-trigger tests without any code changes
    • If tests fail, try re-running failed tests only using the GitHub UI as shown here

Sanity Checklist

  • I have tested my changes using the available tooling
  • I have commented my code
  • I have performed a self-review of my own code; both comments & source code
  • I create and reference any new tickets, if applicable
  • I have left TODOs throughout the codebase, if applicable

@Olshansk Olshansk added documentation Improvements or additions to documentation tooling Tooling - CLI, scripts, helpers, off-chain, etc... labels Apr 26, 2024
@Olshansk Olshansk added this to the Shannon Public TestNet milestone Apr 26, 2024
@Olshansk Olshansk self-assigned this Apr 26, 2024
@Olshansk Olshansk changed the title [Docs] Update the quickstart guide to record the final video [Docs] Update Quickstart guide to onboard new devs May 8, 2024
@Olshansk Olshansk requested review from red-0ne and okdas May 8, 2024 20:43
@Olshansk Olshansk marked this pull request as ready for review May 8, 2024 20:43
Copy link
Member Author

@Olshansk Olshansk left a comment

Choose a reason for hiding this comment

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

@red-0ne @okdas Now looking for a deep review of the Quickstart Guide, but more of just an FYI.

PTAL at the auxiliary changes (configs, code, etc) in particular.

Copy link

github-actions bot commented May 8, 2024

The CI will now also run the e2e tests on devnet, which increases the time it takes to complete all CI checks. If you just created a pull request, you might need to push another commit to produce a container image DevNet can utilize to spin up infrastructure. You can use make trigger_ci to push an empty commit.

@github-actions github-actions bot added devnet push-image CI related - pushes images to ghcr.io labels May 8, 2024
config.yml Show resolved Hide resolved
@Olshansk Olshansk merged commit 1b9303e into main May 9, 2024
11 checks passed
@Olshansk Olshansk deleted the update_quickstart branch May 9, 2024 01:01
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.

Great guide, left a couple of comments but should not affect the quickstart story.

@@ -15,5 +15,5 @@ services:
rpc_type: JSON_RPC
- service_id: ollama
endpoints:
- publicly_exposed_url: http://relayminer1:8545
- publicly_exposed_url: http://relayminer2:8545
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure if this is intended to be a working (non-kubernetes) example, so maybe it should remain relayminer1

@@ -1,19 +1,19 @@
signing_key_name: supplier1
signing_key_name: shannon_supplier
Copy link
Contributor

Choose a reason for hiding this comment

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

Make sure shannon_supplier signing key name exists in config.yml and that it has a stake target in Makefile

Olshansk added a commit that referenced this pull request May 9, 2024
bryanchriswhite added a commit that referenced this pull request May 10, 2024
…cept

* pokt/main:
  Reply to red0ne's comments's in #501
  [Docs] Added QuickStart video (#522)
  [Genesis Config] Set MaxValidators to 1 (#520)
  [Docs] Update `Quickstart` guide to onboard new devs (#501)
  [Code Health] chore: cleanup localnet testutils (#515)
  Zero retryLimit Support in ReplayClient (#442)
@bryanchriswhite bryanchriswhite removed push-image CI related - pushes images to ghcr.io devnet-test-e2e labels May 16, 2024
@github-actions github-actions bot removed the devnet label May 16, 2024
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 tooling Tooling - CLI, scripts, helpers, off-chain, etc...
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

None yet

4 participants