Replace steward registry info with pubsub info #261
Conversation
WalkthroughThe recent changes to the documentation focus on how to provide the Certificate Authority (CA) on-chain by creating or updating a Subscriber in the Steward registry. This involves using either the Changes
Sequence Diagram(s) (Beta)sequenceDiagram
participant User
participant SommelierCLI
participant StewardCLI
participant StewardRegistry
User->>SommelierCLI: Add Subscriber
SommelierCLI->>StewardRegistry: Register Subscriber with CA
StewardRegistry-->>SommelierCLI: Confirmation
User->>StewardCLI: Add Subscriber
StewardCLI->>StewardRegistry: Register Subscriber with CA
StewardRegistry-->>StewardCLI: Confirmation
This diagram illustrates the process of adding a subscriber using either the Recent Review DetailsConfiguration used: CodeRabbit UI Files selected for processing (1)
Additional Context UsedLanguageTool (4)
Markdownlint (3)
Additional comments not posted (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range and nitpick comments (5)
docs/04-GeneratingCertificates.md (5)
Line range hint
5-5: Consider adding the missing article "the".- Two-way trust must be established between Steward and Strategy Provider client for each request. + Two-way trust must be established between Steward and the Strategy Provider client for each request.
Line range hint
33-33: Correct the usage of "publically" to "publicly".- The final two prompts will ask for the domain name where Steward will be publically hosted. + The final two prompts will ask for the domain name where Steward will be publicly hosted.
Line range hint
33-33: Add the missing article "the".- At least one of these MUST be set for Steward to start up with certificate. + At least one of these MUST be set for Steward to start up with the certificate.
Line range hint
62-62: Remove extra blank lines.Please ensure to remove the extra blank lines at the end of the document to maintain a clean and professional format.
Line range hint
17-17: Specify language for code blocks.Please specify the language for the fenced code blocks to enhance readability and syntax highlighting. For example, use ```bash for Bash scripts.
Also applies to: 39-39
| 8. Provide your CA to the Strategy Provider | ||
|
|
||
| Add your information to the [Steward Registry](https://github.com/peggyjv/steward-registry) by following the steps outlined in the README there. | ||
| As a reminder, your "push URL" is the combination of the fully qualified domain name of your production Steward instance and the port configured for your Steward server. For example `steward.example.com:5734`. |
There was a problem hiding this comment.
Add a comma after "for example".
- For example `steward.example.com:5734`.
+ For example, `steward.example.com:5734`.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| As a reminder, your "push URL" is the combination of the fully qualified domain name of your production Steward instance and the port configured for your Steward server. For example `steward.example.com:5734`. | |
| As a reminder, your "push URL" is the combination of the fully qualified domain name of your production Steward instance and the port configured for your Steward server. For example, `steward.example.com:5734`. |
Summary by CodeRabbit
sommelierCLI andstewardCLI for adding subscribers.