Skip to content

Update documentation and user guides for beta snapshotter #508

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
Merged
merged 1 commit into from
May 15, 2020
Merged

Update documentation and user guides for beta snapshotter #508

merged 1 commit into from
May 15, 2020

Conversation

saikat-royc
Copy link
Member

What type of PR is this?

Uncomment only one /kind <> line, hit enter to put that in a new line, and remove leading whitespaces from that line:

/kind api-change
/kind bug
/kind cleanup
/kind design
/kind documentation
/kind failing-test
/kind feature
/kind flake

What this PR does / why we need it:
Update the documentation and user guides for beta snapshotter feature.
Which issue(s) this PR fixes:

Fixes #457

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

Update documentation and user guides for beta snapshotter

@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels May 14, 2020
@k8s-ci-robot
Copy link
Contributor

Hi @saikat-royc. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

@k8s-ci-robot k8s-ci-robot requested review from davidz627 and msau42 May 14, 2020 16:46
@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label May 14, 2020
@saikat-royc
Copy link
Member Author

/cc @msau42

@msau42
Copy link
Contributor

msau42 commented May 14, 2020

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels May 14, 2020
msau42
msau42 reviewed May 14, 2020
View reviewed changes
@saikat-royc saikat-royc force-pushed the beta-snapshotter-documentation branch 3 times, most recently from 59b5b0f to af4da09 Compare May 14, 2020 22:32
@saikat-royc saikat-royc force-pushed the beta-snapshotter-documentation branch 2 times, most recently from c50fe11 to 628b621 Compare May 14, 2020 23:47
@saikat-royc saikat-royc force-pushed the beta-snapshotter-documentation branch from 628b621 to 56a992d Compare May 15, 2020 17:26
msau42
msau42 reviewed May 15, 2020
View reviewed changes
docs/kubernetes/user-guides/snapshots.md Outdated
GCE_PD_DRIVER_VERSION=alpha # Driver version to deploy
./deploy/kubernetes/deploy-driver.sh
```
### Install Driver with beta snapshot feature as described [here] (driver-install.md)
Copy link
Contributor

Choose a reason for hiding this comment

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

When I preview this file, the link isn't showing up properly. I think you need to remove the space between "]" and "("

Copy link
Member Author

Choose a reason for hiding this comment

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

Ah. Thanks for the preview tip. Fixed it.

@saikat-royc saikat-royc force-pushed the beta-snapshotter-documentation branch from 56a992d to 6daa9d4 Compare May 15, 2020 17:51
@msau42
Copy link
Contributor

msau42 commented May 15, 2020

/lgtm
/approve
Thanks!

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 15, 2020
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: msau42, saikat-royc

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 15, 2020
@k8s-ci-robot k8s-ci-robot merged commit ac1f8c0 into kubernetes-sigs:master May 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@msau42 msau42 msau42 left review comments

@davidz627 davidz627 Awaiting requested review from davidz627

Assignees

@msau42 msau42

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update deployments to include new snapshot controller (for v1beta1 APIs), start running tests, and update docs
3 participants
@saikat-royc @k8s-ci-robot @msau42