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

Documentation on the external-snaphot-metadata sidecar (alpha). #605

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

carlbraganza
Copy link

No description provided.

@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 22, 2024
@k8s-ci-robot
Copy link
Contributor

Adding the "do-not-merge/release-note-label-needed" label because no release-note block was detected, please follow our release note process to remove it.

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-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. label Oct 22, 2024
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Oct 22, 2024
Copy link
Member

@nixpanic nixpanic left a comment

Choose a reason for hiding this comment

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

Some of the references to the KEP (like the CR, "Risks and Mitigations") could be included here directly, it'll be a much simpler read for the users.

book/src/changed-block-tracking.md Outdated Show resolved Hide resolved
@carlbraganza carlbraganza force-pushed the snapshot-metadata-sidecar-alpha branch from b5fd8df to 8c9996b Compare January 15, 2025 18:53
@k8s-ci-robot k8s-ci-robot 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 Jan 15, 2025
@carlbraganza carlbraganza force-pushed the snapshot-metadata-sidecar-alpha branch 3 times, most recently from 9fea794 to 4c157ba Compare January 15, 2025 21:32
@carlbraganza carlbraganza requested a review from nixpanic January 15, 2025 21:34
@carlbraganza carlbraganza force-pushed the snapshot-metadata-sidecar-alpha branch 2 times, most recently from 3f3e5b0 to b5a4524 Compare January 15, 2025 21:43
@carlbraganza
Copy link
Author

The documentation has been updated to reflect the alpha version of v0.1.0.
Links to images and references to the hostpath CSI driver are slightly premature as they depend pending PRs and cutting the alpha release.
I'll remove the draft mode once this is done.

@carlbraganza carlbraganza force-pushed the snapshot-metadata-sidecar-alpha branch from b5a4524 to 7a41ef4 Compare January 17, 2025 18:45
@carlbraganza carlbraganza force-pushed the snapshot-metadata-sidecar-alpha branch from 7a41ef4 to 0d6ca24 Compare January 17, 2025 19:47
@carlbraganza
Copy link
Author

@nixpanic @Rakshith-R Thanks for the feedback so far.

I've reshuffled some material slightly by adding a "Resources" section to clearly identify programming artifacts available to application developers and CSI driver developers. I think it will make things much more obvious.

I've also tried to be consistent with the naming, and reduce hyperlinks to just 1 per section.

Copy link

@Rakshith-R Rakshith-R left a comment

Choose a reason for hiding this comment

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

Thanks,
/lgtm

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

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: carlbraganza, Rakshith-R
Once this PR has been reviewed and has the lgtm label, please assign lpabon for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. lgtm "Looks good to me", 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.

4 participants