Skip to content

doc: fix snapshot crd illegal characters #1295

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion client/apis/volumesnapshot/v1/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -344,7 +344,7 @@ type VolumeSnapshotContentSpec struct {
Source VolumeSnapshotContentSource `json:"source" protobuf:"bytes,5,opt,name=source"`

// SourceVolumeMode is the mode of the volume whose snapshot is taken.
// Can be either Filesystem or Block.
// Can be either "Filesystem" or "Block".
// If not specified, it indicates the source volume's mode is unknown.
// This field is immutable.
// This field is an alpha field.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ spec:
sourceVolumeMode:
description: |-
SourceVolumeMode is the mode of the volume whose snapshot is taken.
Can be either Filesystem or Block.
Can be either "Filesystem" or "Block".
Copy link
Collaborator

Choose a reason for hiding this comment

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

This yaml is automatically generated.

Copy link
Member

Choose a reason for hiding this comment

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

@xing-yang do you know where is the source of this generated file? it's a Chinese quote char which needs to be fixed since it would fail our yamllint check test.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think it's generated by client/apis/volumesnapshot/v1/types.go, and also fix it

Copy link
Contributor Author

Choose a reason for hiding this comment

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

seems it's not source file, vendor will fail the test

If not specified, it indicates the source volume's mode is unknown.
This field is immutable.
This field is an alpha field.
Expand Down