Merge pull request #1895 from marquiz/devel/docs-quoting

docs: quote shell snippets containing urls with query parameters

Author: k8s-ci-robot

README.md

@@ -12,7 +12,7 @@ features and system configuration!
 #### Quick-start – the short-short version
 
 ```bash
-$ kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref=v0.16.4
+$ kubectl apply -k "https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref=v0.16.4"
   namespace/node-feature-discovery created
   customresourcedefinition.apiextensions.k8s.io/nodefeaturerules.nfd.k8s-sigs.io created
   customresourcedefinition.apiextensions.k8s.io/nodefeatures.nfd.k8s-sigs.io created
@@ -38,7 +38,7 @@ $ kubectl -n node-feature-discovery get all
   pod/nfd-worker-nwdp6              1/1     Running   0          18s
 ...
 
-$ kubectl get no -o json | jq '.items[].metadata.labels'
+$ kubectl get no -o json | jq ".items[].metadata.labels"
   {
     "kubernetes.io/arch": "amd64",
     "kubernetes.io/os": "linux",

docs/deployment/kustomize.md

@@ -26,7 +26,7 @@ later is required.
 The kustomize overlays provided in the repo can be used directly:
 
 ```bash
-kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref={{ site.release }}
+kubectl apply -k "https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref={{ site.release }}"
 ```
 
 This will required RBAC rules and deploy nfd-master (as a deployment) and
@@ -77,7 +77,7 @@ The `default-job` overlay may be used to achieve this:
 
 ```bash
 NUM_NODES=$(kubectl get no -o jsonpath='{.items[*].metadata.name}' | wc -w)
-kubectl kustomize https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default-job?ref={{ site.release }} | \
+kubectl kustomize "https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default-job?ref={{ site.release }}" | \
     sed s"/NUM_NODES/$NUM_NODES/" | \
     kubectl apply -f -
 ```
@@ -94,7 +94,7 @@ deployed as separate pods. The `master-worker-topologyupdater` overlay may be
 used to achieve this:
 
 ```bash
-kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/master-worker-topologyupdater?ref={{ site.release }}
+kubectl apply -k "https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/master-worker-topologyupdater?ref={{ site.release }}"
 
 ```
 
@@ -104,7 +104,7 @@ To deploy just nfd-topology-updater (without nfd-master and nfd-worker)
 use the `topologyupdater` overlay:
 
 ```bash
-kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/topologyupdater?ref={{ site.release }}
+kubectl apply -k "https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/topologyupdater?ref={{ site.release }}"
 
 ```
 
@@ -114,8 +114,8 @@ are deployed as separate pods;
 
 ```bash
 
-kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref={{ site.release }}
-kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/topologyupdater?ref={{ site.release }}
+kubectl apply -k "https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref={{ site.release }}"
+kubectl apply -k "https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/topologyupdater?ref={{ site.release }}"
 
 ```
 
@@ -126,8 +126,8 @@ to scrape metrics from node-feature-discovery,
 run the following command:
 
 ```bash
-kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref={{ site.release }}
-kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/prometheus?ref={{ site.release }}
+kubectl apply -k "https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref={{ site.release }}"
+kubectl apply -k "https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/prometheus?ref={{ site.release }}"
 ```
 
 ## Uninstallation

docs/deployment/uninstallation.md

@@ -24,9 +24,9 @@ nfd-related node labels, annotations, extended resources and taints from the
 cluster.
 
 ```bash
-kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/prune?ref={{ site.release }}
+kubectl apply -k "https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/prune?ref={{ site.release }}"
 kubectl -n node-feature-discovery wait job.batch/nfd-master --for=condition=complete && \
-    kubectl delete -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/prune?ref={{ site.release }}
+    kubectl delete -k "https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/prune?ref={{ site.release }}"
 ```
 
 > **NOTE:** You must run prune before removing the RBAC rules (serviceaccount,

docs/get-started/quick-start.md

@@ -14,7 +14,7 @@ Deploy with kustomize -- creates a new namespace, service and required RBAC
 rules and deploys nfd-master and nfd-worker daemons.
 
 ```bash
-kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref={{ site.release }}
+kubectl apply -k "https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/default?ref={{ site.release }}"
 ```
 
 ## Verify
@@ -34,7 +34,7 @@ deployment.apps/nfd-master   1/1     1            1           17s
 Check that NFD feature labels have been created
 
 ```bash
-$ kubectl get no -o json | jq '.items[].metadata.labels'
+$ kubectl get no -o json | jq ".items[].metadata.labels"
 {
   "kubernetes.io/arch": "amd64",
   "kubernetes.io/os": "linux",
@@ -82,7 +82,7 @@ To deploy nfd-topology-updater use the `topologyupdater` kustomize
 overlay.
 
 ```bash
-kubectl apply -k https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/topologyupdater?ref={{ site.release }}
+kubectl apply -k "https://github.com/kubernetes-sigs/node-feature-discovery/deployment/overlays/topologyupdater?ref={{ site.release }}"
 ```
 
 ### Verify nfd-topology-updater