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

Add documentation about new ScyllaCluster's exposing options #1432

Merged
merged 1 commit into from
Oct 4, 2023

Conversation

zimnx
Copy link
Collaborator

@zimnx zimnx commented Sep 29, 2023

Documentation covers meaning and configuration options of new fields in exposeOptions added in #1359.
Selected examples explains how clients and nodes interconnect ScyllaCluster nodes.

Fixes #1380

@zimnx zimnx added the kind/documentation Categorizes issue or PR as related to documentation. label Sep 29, 2023
@scylla-operator-bot scylla-operator-bot bot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Sep 29, 2023
@rzetelskik
Copy link
Member

/hold
for #1418, since you're using colon-fence for notes

@scylla-operator-bot scylla-operator-bot bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 2, 2023
Copy link
Member

@rzetelskik rzetelskik left a comment

Choose a reason for hiding this comment

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

went through first half

docs/source/exposing.md Outdated Show resolved Hide resolved
docs/source/exposing.md Outdated Show resolved Hide resolved
docs/source/exposing.md Outdated Show resolved Hide resolved
docs/source/exposing.md Outdated Show resolved Hide resolved
docs/source/exposing.md Outdated Show resolved Hide resolved
docs/source/exposing.md Outdated Show resolved Hide resolved
docs/source/exposing.md Outdated Show resolved Hide resolved
docs/source/exposing.md Outdated Show resolved Hide resolved
docs/source/exposing.md Outdated Show resolved Hide resolved
docs/source/exposing.md Outdated Show resolved Hide resolved
@rzetelskik
Copy link
Member

/cc @annastuchlik

Copy link
Member

@tnozicka tnozicka left a comment

Choose a reason for hiding this comment

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

good job!
a bit of wording comments

docs/source/exposing.md Outdated Show resolved Hide resolved
docs/source/exposing.md Outdated Show resolved Hide resolved
docs/source/exposing.md Outdated Show resolved Hide resolved
docs/source/exposing.md Outdated Show resolved Hide resolved
docs/source/exposing.md Outdated Show resolved Hide resolved
docs/source/exposing.md Outdated Show resolved Hide resolved
docs/source/exposing.md Outdated Show resolved Hide resolved
docs/source/exposing.md Show resolved Hide resolved
docs/source/exposing.md Show resolved Hide resolved
docs/source/exposing.md Outdated Show resolved Hide resolved
docs/source/exposing.md Outdated Show resolved Hide resolved
docs/source/exposing.md Outdated Show resolved Hide resolved
docs/source/exposing.md Outdated Show resolved Hide resolved
docs/source/exposing.md Outdated Show resolved Hide resolved
docs/source/exposing.md Show resolved Hide resolved
docs/source/exposing.md Outdated Show resolved Hide resolved
docs/source/exposing.md Outdated Show resolved Hide resolved
@rzetelskik
Copy link
Member

rzetelskik commented Oct 3, 2023

@zimnx let's change the myst's colon fence syntax back to rst to decouple from #1418. Feel free to cancel the hold once you've updated the commit.

@zimnx zimnx force-pushed the mz/expose-docs branch 2 times, most recently from 4b325f2 to 1dc4eb3 Compare October 3, 2023 09:25
@zimnx
Copy link
Collaborator Author

zimnx commented Oct 3, 2023

/hold cancel
myst stuff is removed

@scylla-operator-bot scylla-operator-bot bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 3, 2023
docs/source/exposing.md Outdated Show resolved Hide resolved
docs/source/exposing.md Outdated Show resolved Hide resolved
docs/source/exposing.md Outdated Show resolved Hide resolved
docs/source/exposing.md Show resolved Hide resolved
docs/source/exposing.md Outdated Show resolved Hide resolved
docs/source/exposing.md Show resolved Hide resolved
docs/source/exposing.md Outdated Show resolved Hide resolved
docs/source/exposing.md Outdated Show resolved Hide resolved
docs/source/exposing.md Outdated Show resolved Hide resolved
docs/source/exposing.md Outdated Show resolved Hide resolved
@rzetelskik
Copy link
Member

@zimnx thanks for the updates, I resolved most comments and left a few new ones

@zimnx zimnx force-pushed the mz/expose-docs branch 3 times, most recently from 8fe1a88 to 20491e3 Compare October 3, 2023 13:32
@zimnx zimnx requested a review from rzetelskik October 4, 2023 07:33
@rzetelskik
Copy link
Member

/approve
/assign @tnozicka

Documentation covers meaning and configuration options of new fields in
`exposeOptions`.
Selected examples explains how clients and nodes interconnect
ScyllaCluster nodes.
Copy link
Member

@tnozicka tnozicka left a comment

Choose a reason for hiding this comment

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

/lgtm

thanks

@scylla-operator-bot scylla-operator-bot bot added the lgtm Indicates that a PR is ready to be merged. label Oct 4, 2023
@scylla-operator-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: rzetelskik, tnozicka, zimnx

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@scylla-operator-bot scylla-operator-bot bot merged commit d4bb541 into scylladb:master Oct 4, 2023
8 checks passed
@zimnx zimnx deleted the mz/expose-docs branch October 4, 2023 12:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document new networking options for exposing ScyllaClusters
3 participants