-
Notifications
You must be signed in to change notification settings - Fork 547
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
doc: fix mdl related failures #3510
Conversation
docs/ceph-csi-upgrade.md
Outdated
@@ -114,7 +114,8 @@ git checkout v3.7.2 | |||
``` | |||
|
|||
```console | |||
Warning: kubectl apply should be used on resource created by either kubectl create --save-config or kubectl apply | |||
Warning: kubectl apply should be used on resource created by |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The console
output examples are expected to be on a single line. These lines may become long, and that is OK in these cases. Is there no way to mark these kind of blocks so that they can contain long lines? Maybe in the configuration file, or by adding an annotation?
docs/deploy-cephfs.md
Outdated
@@ -204,8 +204,11 @@ NAME READY STATUS RESTARTS AGE | |||
pod/csi-cephfsplugin-provisioner-0 4/4 Running 0 25s | |||
pod/csi-cephfsplugin-rljcv 3/3 Running 0 24s | |||
|
|||
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE | |||
service/csi-cephfsplugin-provisioner ClusterIP 10.101.78.75 <none> 8080/TCP 26s | |||
NAME TYPE CLUSTER-IP EXTERNAL-IP |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
specially lines like this are not expected to be split
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey, thanks for the review Niels.
I have changed the ignore_code_blocks parameter to true, so that it will ignore the checks for these cases.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great, that should be fine. No need to add the lin-breaks in those blocks then, so you'll have to undo those changes 😉
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right, updated those.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Still a few line-breaks in console and bash outputs. Please correct them, thanks!
docs/ceph-mount-corruption.md
Outdated
@@ -18,7 +18,8 @@ ls: /cephfs-share: Socket not connected | |||
or, | |||
|
|||
``` | |||
# stat /home/kubelet/pods/ae344b80-3b07-4589-b1a1-ca75fa9debf2/volumes/kubernetes.io~csi/pvc-ec69de59-7823-4840-8eee-544f8261fef0/mount: transport endpoint is not connected | |||
# stat /home/kubelet/pods/ae344b80-3b07-4589-b1a1-ca75fa9debf2/volumes/kubernetes.io~csi/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are still quite a few blocks that contain console output. Maybe these need to be marked with
```console
for them to allow long lines?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated.
Just putting this (```) will mark it as a code blocks, and it will be ignored.
docs/coding.md
Outdated
@@ -79,7 +79,9 @@ is within the line length limit and help on code reading. | |||
Example: | |||
|
|||
``` | |||
_, err := framework.RunKubectl(cephCSINamespace, "delete", "cm", "ceph-csi-encryption-kms-config", "--namespace", cephCSINamespace, "--ignore-not-found=true") | |||
_, err := framework.RunKubectl(cephCSINamespace, "delete", "cm", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is Go code, so use
```go
to mark is as such
/test ci/centos/k8s-e2e-external-storage/1.23 |
/test ci/centos/k8s-e2e-external-storage/1.24 |
/test ci/centos/k8s-e2e-external-storage/1.25 |
/test ci/centos/mini-e2e-helm/k8s-1.23 |
/test ci/centos/mini-e2e-helm/k8s-1.24 |
/test ci/centos/mini-e2e-helm/k8s-1.25 |
/test ci/centos/mini-e2e/k8s-1.23 |
/test ci/centos/mini-e2e/k8s-1.24 |
/test ci/centos/mini-e2e/k8s-1.25 |
/test ci/centos/upgrade-tests-cephfs |
/test ci/centos/upgrade-tests-rbd |
This commit address the issue- #3448. Signed-off-by: riya-singhal31 <rsinghal@redhat.com>
/test ci/centos/k8s-e2e-external-storage/1.23 |
/test ci/centos/k8s-e2e-external-storage/1.24 |
/test ci/centos/k8s-e2e-external-storage/1.25 |
/test ci/centos/mini-e2e-helm/k8s-1.23 |
/test ci/centos/mini-e2e-helm/k8s-1.24 |
/test ci/centos/mini-e2e-helm/k8s-1.25 |
/test ci/centos/mini-e2e/k8s-1.23 |
/test ci/centos/mini-e2e/k8s-1.24 |
/test ci/centos/mini-e2e/k8s-1.25 |
/test ci/centos/upgrade-tests-cephfs |
/test ci/centos/upgrade-tests-rbd |
Signed-off-by: riya-singhal31 rsinghal@redhat.com
Fixes: #3448