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.

Sign up for GitHub

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

Jump to bottom

Add support and must-gather documentation #1504

Merged
merged 1 commit into from
Nov 2, 2023
Merged

Add support and must-gather documentation #1504

merged 1 commit into from
Nov 2, 2023

Conversation

tnozicka
Copy link
Member

@tnozicka tnozicka commented Oct 20, 2023 •
edited
Loading

Description of your changes:
This PR adds documentation for must-gather tool and structures and extend our support content.

Which issue is resolved by this Pull Request:
Resolves #1367

@tnozicka tnozicka added priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. kind/documentation Categorizes issue or PR as related to documentation. labels Oct 20, 2023
@scylla-operator-bot
Copy link
Contributor

@tnozicka: GitHub didn't allow me to request PR reviews from the following users: tnozicka.

Note that only scylladb members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

Description of your changes:
TODO

Which issue is resolved by this Pull Request:
Resolves #1367

/cc

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@scylla-operator-bot scylla-operator-bot bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 20, 2023
@tnozicka tnozicka marked this pull request as draft October 20, 2023 14:47
@scylla-operator-bot scylla-operator-bot bot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Oct 20, 2023
@tnozicka tnozicka force-pushed the must-gather-docs branch 3 times, most recently from ec0799b to 8df0529 Compare October 24, 2023 12:41
@scylla-operator-bot scylla-operator-bot bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Oct 24, 2023
@tnozicka tnozicka force-pushed the must-gather-docs branch 8 times, most recently from e260beb to c5ba970 Compare October 24, 2023 13:30
@tnozicka tnozicka changed the title [WIP] Add docs for must-gather Add support documentation and must-gather Oct 24, 2023
@tnozicka tnozicka changed the title Add support documentation and must-gather Add support and must-gather documentation Oct 24, 2023
@tnozicka tnozicka marked this pull request as ready for review October 24, 2023 13:31
@scylla-operator-bot scylla-operator-bot bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 24, 2023
tnozicka
tnozicka commented Oct 24, 2023
View reviewed changes
docs/source/support/overview.md

## Get support

ScyllaDB provides administrators with [paid support](https://www.scylladb.com/product/support/#enterprise-support), including Scylla Operator.
Copy link
Member Author

Choose a reason for hiding this comment

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

/cc @tzach
please check if the wording and the link are ok.

I didn't find a closer link to a customer portal. https://www.scylladb.com/customer-portal/ redirects to https://www.scylladb.com/download/#enterprise which gets a bit confusing if you follow this path.

@scylla-operator-bot scylla-operator-bot bot requested a review from tzach October 24, 2023 13:35
rzetelskik
rzetelskik reviewed Oct 24, 2023
View reviewed changes
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.

PR is missing a description

docs/source/index.rst Outdated Show resolved Hide resolved
docs/source/support/index.rst Show resolved Hide resolved
docs/source/support/overview.md Show resolved Hide resolved
docs/source/support/troubleshooting/index.rst Show resolved Hide resolved
docs/source/support/must-gather.md Outdated Show resolved Hide resolved
docs/source/support/must-gather.md Outdated Show resolved Hide resolved
docs/source/support/must-gather.md Outdated Show resolved Hide resolved
docs/source/support/must-gather.md Show resolved Hide resolved
docs/source/support/troubleshooting/index.rst Show resolved Hide resolved
docs/source/support/troubleshooting/installation.md Outdated Show resolved Hide resolved
@tnozicka tnozicka force-pushed the must-gather-docs branch 2 times, most recently from ddb3b79 to 4cb2d81 Compare October 25, 2023 08:13
@tnozicka tnozicka changed the title Add support and must-gather documentation [WIP] Add support and must-gather documentation Oct 25, 2023
@scylla-operator-bot scylla-operator-bot bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 25, 2023
@tnozicka tnozicka force-pushed the must-gather-docs branch 2 times, most recently from dd465a6 to fea55a3 Compare October 25, 2023 13:27
@tnozicka tnozicka changed the title [WIP] Add support and must-gather documentation Add support and must-gather documentation Oct 25, 2023
@scylla-operator-bot scylla-operator-bot bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 25, 2023
zimnx
zimnx approved these changes Oct 27, 2023
View reviewed changes
Copy link
Collaborator

@zimnx zimnx left a comment

Choose a reason for hiding this comment

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

one optional nit,
/assign rzetelskik

docs/source/support/overview.md Outdated

## Troubleshooting issues

* [Installation issues](troubleshooting/installation.md)
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit: I think pointing here to the index page of troubleshooting instead having a bullet list of subpages would be more extensible in future.

Copy link
Member Author

Choose a reason for hiding this comment

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

fixed

@tnozicka tnozicka requested a review from rzetelskik November 1, 2023 16:52
rzetelskik
rzetelskik approved these changes Nov 2, 2023
View reviewed changes
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.

one nit

docs/source/support/overview.md Outdated Show resolved Hide resolved
@scylla-operator-bot 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

@rzetelskik
Copy link
Member

Thanks for the updates!
/lgtm

@scylla-operator-bot scylla-operator-bot bot added the lgtm Indicates that a PR is ready to be merged. label Nov 2, 2023
@scylla-operator-bot scylla-operator-bot bot merged commit 964418f into scylladb:master Nov 2, 2023
8 checks passed
@zimnx
Copy link
Collaborator

zimnx commented Nov 2, 2023

Please backport it to v1.11, thanks!

@tnozicka tnozicka mentioned this pull request Nov 2, 2023
Merged
@tnozicka tnozicka deleted the must-gather-docs branch November 2, 2023 10:33
@tnozicka tnozicka mentioned this pull request Mar 1, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rzetelskik rzetelskik rzetelskik approved these changes

@zimnx zimnx zimnx approved these changes

@tzach tzach Awaiting requested review from tzach

Assignees

@rzetelskik rzetelskik

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. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add docs about using must-gather
3 participants
@tnozicka @rzetelskik @zimnx