Skip to content
This repository has been archived by the owner on Aug 21, 2024. It is now read-only.

Add RPC Deployment Details to RPC Usage Page #624

Merged
merged 11 commits into from
Nov 1, 2023
Merged

Add RPC Deployment Details to RPC Usage Page #624

merged 11 commits into from
Nov 1, 2023

Conversation

stellarsaur
Copy link
Contributor

This PR updates the RPC Usage page to contain information in our Soroban RPC Runbook for infrastructure providers.

Specifically:

  • Caution that our Quickstart image is only for development purposes and should not be used in productoin
  • Add instructions for deploying using our soroban-rpc docker image
  • Add instructions for configuring your deployment from CLI and using a TOML configuration file
  • Add instructions for building Soroban RPC from source
  • Add instructions for verifying your Soroban RPC instance is healthy
  • Add instructions for monitoring your Soroban RPC instance
  • Add recommended hardware requirements based on load tests

@stellarsaur stellarsaur added the documentation (fix) Reword, clarify, add to, remove, etc. bits of content that already exist label Oct 25, 2023
@stellarsaur stellarsaur self-assigned this Oct 25, 2023
@stellar-jenkins
Copy link

Preview is available here:
http://soroban-docs-pr624.previews.kube001.services.stellar-ops.com/

@stellar-jenkins
Copy link

Preview is available here:
http://soroban-docs-pr624.previews.kube001.services.stellar-ops.com/

@ElliotFriend ElliotFriend self-requested a review October 26, 2023 17:16
ElliotFriend
ElliotFriend reviewed Oct 26, 2023
View reviewed changes
Copy link
Contributor

@ElliotFriend ElliotFriend left a comment

Choose a reason for hiding this comment

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

Really great additions to this page! Thank you for helping out with it! I've left a few comments and small nitpicks, but I think it's really close!

@briwylde08 Would you be able to run over some of the newer content here from an editorial view?

docs/reference/rpc.mdx Outdated Show resolved Hide resolved
docs/reference/rpc.mdx Outdated Show resolved Hide resolved
docs/reference/rpc.mdx Outdated Show resolved Hide resolved
docs/reference/rpc.mdx Outdated Show resolved Hide resolved
docs/reference/rpc.mdx Outdated Show resolved Hide resolved
docs/reference/rpc.mdx Outdated Show resolved Hide resolved
docs/reference/rpc.mdx Outdated Show resolved Hide resolved
docs/reference/rpc.mdx Outdated Show resolved Hide resolved
@stellar-jenkins
Copy link

Something went wrong with PR preview build please check

@stellar-jenkins
Copy link

Preview is available here:
http://soroban-docs-pr624.previews.kube001.services.stellar-ops.com/

3 similar comments
@stellar-jenkins
Copy link

Preview is available here:
http://soroban-docs-pr624.previews.kube001.services.stellar-ops.com/

@stellar-jenkins
Copy link

Preview is available here:
http://soroban-docs-pr624.previews.kube001.services.stellar-ops.com/

@stellar-jenkins
Copy link

Preview is available here:
http://soroban-docs-pr624.previews.kube001.services.stellar-ops.com/

@stellarsaur
Copy link
Contributor Author

Thanks for the review! Made the requested changes so it should be ready for another round.

@stellar-jenkins
Copy link

Preview is available here:
http://soroban-docs-pr624.previews.kube001.services.stellar-ops.com/

1 similar comment
@stellar-jenkins
Copy link

Preview is available here:
http://soroban-docs-pr624.previews.kube001.services.stellar-ops.com/

briwylde08
briwylde08 approved these changes Oct 31, 2023
View reviewed changes
Copy link
Contributor

@briwylde08 briwylde08 left a comment

Choose a reason for hiding this comment

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

Editorial complete!

@stellar-jenkins
Copy link

Preview is available here:
http://soroban-docs-pr624.previews.kube001.services.stellar-ops.com/

1 similar comment
@stellar-jenkins
Copy link

Preview is available here:
http://soroban-docs-pr624.previews.kube001.services.stellar-ops.com/

@stellarsaur stellarsaur merged commit dd3ce0b into main Nov 1, 2023
1 check passed
@stellarsaur stellarsaur deleted the rpc-runbook branch November 1, 2023 15:54
@stellarsaur stellarsaur mentioned this pull request Nov 1, 2023
Closed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@briwylde08 briwylde08 briwylde08 approved these changes

@ElliotFriend ElliotFriend Awaiting requested review from ElliotFriend

Assignees

@stellarsaur stellarsaur

Labels
documentation (fix) Reword, clarify, add to, remove, etc. bits of content that already exist
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@stellarsaur @stellar-jenkins @ElliotFriend @briwylde08