Upgrade to a more recent version of markdownlint-cli (#5800)

From 0.31.1 to 0.38.0

We have not upgraded the version used in CI for a long time, and the new
version includes some additional checks such as MD051 link-fragments
(Link fragments should be valid), which helps avoid deadlinks in the
documentation (internal links in a given document).

Contributors can install the new version of markdownlint-cli using npm
or Brew (macOS).

Signed-off-by: Antonin Bas <antonin.bas@broadcom.com>

.github/workflows/go.yml

@@ -240,7 +240,7 @@ jobs:
         config-file: 'hack/.md_links_config.json'
     - name: Markdownlint
       run: |
-        sudo npm install -g markdownlint-cli@0.31.1
+        sudo npm install -g markdownlint-cli@0.38.0
         make markdownlint
     - name: Checking whether autogenerated Helm chart documentation is up-to-date
       working-directory: build/charts/

.github/workflows/verify_docs.yml

@@ -27,5 +27,5 @@ jobs:
         config-file: 'hack/.md_links_config.json'
     - name: Markdownlint
       run: |
-        sudo npm install -g markdownlint-cli@0.31.1
+        sudo npm install -g markdownlint-cli@0.38.0
         make markdownlint 

ADOPTERS.md

@@ -40,7 +40,7 @@ antrea nodes in one cluster for upgrading.
 4. We use Antrea's Egress feature to keep the original source ip to ensure
 Internal Pods can get the real source IP of the request.
 
-You can contact us with mkt@transwarp.io
+You can contact us with <mkt@transwarp.io>
 
 **[TeraSky](https://terasky.com)**
 
@@ -88,7 +88,7 @@ add a line where people can find you.
 a maximum size of 50KB to the [adopters](docs/assets/adopters) directory.
 Name the image file something that reflects your company (e.g., if your company
 is called Acme, name the image acme-logo.png). Then add an inline html link
-directly bellow the [Antrea Adopters section](#Antrea-Adopters). Use the
+directly bellow the [Antrea Adopters section](#antrea-adopters). Use the
 following format:
 
     ```html

CONTRIBUTING.md

@@ -367,10 +367,10 @@ labels are included on your issue:
   will ensure the appropriate reviewers shepherd the issue or PR through to its
   closure. For an overview of areas, see the
   [`docs/github-labels.md`](docs/contributors/github-labels.md).
-* **size** (optional) -- if you have an idea of the size (lines of code, complexity,
-  effort) of the issue, you can label it using a [size label](#size). The size
-  can be updated during backlog grooming by contributors. This estimate is used
-  to guide the number of features selected for a milestone.
+* **size** (optional) -- if you have an idea of the size (lines of code,
+  complexity, effort) of the issue, you can label it using a size label. The
+  size can be updated during backlog grooming by contributors. This estimate is
+  used to guide the number of features selected for a milestone.
 
 All other labels will be assigned during issue triage.
 

GOVERNANCE.md

@@ -73,7 +73,7 @@ A supermajority is defined as two-thirds of members in the group.
 
 The code of conduct is overseen by the Antrea project maintainers. Possible code
 of conduct violations should be emailed to the project maintainers at
-cncf-antrea-maintainers@lists.cncf.io.
+<cncf-antrea-maintainers@lists.cncf.io>.
 
 If the possible violation is against one of the project maintainers that member
 will be recused from voting on the issue. Such issues must be escalated to the

SECURITY.md

@@ -7,7 +7,7 @@ The community adopted this security disclosure policy to ensure vulnerabilities
 
 If you believe you have identified a vulnerability, please work with the Antrea maintainers to fix it and disclose the issue responsibly.
 All security issues, confirmed or suspected, should be reported privately.
-Please avoid using github issues, and instead report the vulnerability to cncf-antrea-maintainers@lists.cncf.io.
+Please avoid using github issues, and instead report the vulnerability to <cncf-antrea-maintainers@lists.cncf.io>.
 
 A vulnerability report should be filed if any of the following applies:
 
@@ -29,7 +29,7 @@ Provide a descriptive subject and include the following information in the body:
 ## Responding to a vulnerability
 
 A coordinator is assigned to each reported security issue. The coordinator is a member from the Antrea maintainers team, and will drive the fix and disclosure process.
-At the moment reports are received via email at cncf-antrea-maintainers@lists.cncf.io.
+At the moment reports are received via email at <cncf-antrea-maintainers@lists.cncf.io>.
 The first steps performed by the coordinator are to confirm the validity of the report and send an embargo reminder to all parties involved.
 Antrea maintainers and issue reporters will review the issue for confirmation of impact and determination of affected components.
 
@@ -59,7 +59,7 @@ A fix is proposed as a patch to the current main branch, formatted with:
 git format-patch --stdout HEAD~1 > path/to/local/file.patch
 ```
 
-and then sent to cncf-antrea-maintainers@lists.cncf.io.
+and then sent to <cncf-antrea-maintainers@lists.cncf.io>.
 
 **Please don't push the patch to the Antrea fork on your github account!**
 

ci/jenkins/README.md

@@ -199,7 +199,7 @@ set -e
 
 * [daily-whole-conformance](https://jenkins.antrea-ci.rocks/job/antrea-daily-whole-conformance-for-period/):
   daily community tests using sonobuoy, with certified-conformance mode. If build fails, Jenkins will
-  send an email to projectantrea-dev@googlegroups.com for notification.
+  send an email to <projectantrea-dev@googlegroups.com> for notification.
 
 * Microsoft Windows conformance: community tests related to Microsoft Windows.
   It focuses on: "[sig-network].+[Conformance]|[sig-windows]".

docs/cookbooks/multus/README.md

@@ -194,7 +194,7 @@ are using.
 
 ## Using DHCP for IPAM
 
-To use DHCP for IPAM, you need not create the Antrea `IPPool` CR in [step-3],
+To use DHCP for IPAM, you need not create the Antrea `IPPool` CR in [step-3](#step-3-create-an-ippool-and-a-networkattachmentdefinition),
 and `dhcp` should be specified as the IPAM type in the
 `NetworkAttachmentDefinition` CR created.  And, two more extra steps are
 required, after step 1 - 4.
@@ -208,8 +208,8 @@ statically), you may want to deploy a DHCP server in the K8s cluster,
 and use it to assign IP addresses to the macvlan secondary interfaces. In
 particular, this is the case if you are using our [test cluster].
 
-Note that in order to deploy the DHCP server in-cluster, [step-4] is
-required. You can then apply the following manifest after making the necessary
+Note that in order to deploy the DHCP server in-cluster, [step-4](#step-4-optional-create-a-macvlan-subinterface-on-each-node)
+is required. You can then apply the following manifest after making the necessary
 edits:
 
 ```bash
@@ -378,9 +378,3 @@ You can then validate that the configuration works by running the same
 [Whereabouts]: https://github.com/dougbtv/whereabouts
 [test cluster]: #suggested-test-cluster
 [DHCP]: #using-dhcp-for-ipam
-[step-1]: #step-1-deploying-antrea
-[step-2]: #step-2-deploy-multus-as-a-daemonset
-[step-3]: #step-3-create-an-ippool-and-a-networkattachmentdefinition
-[step-4]: #step-4-optional-create-a-macvlan-subinterface-on-each-node
-[step-5]: #step-5-run-a-dhcp-server
-[step-6]: #step-6-run-the-dhcp-daemons

docs/design/architecture.md

@@ -45,7 +45,7 @@ to implement the communication channel to Antrea Agents. Each Antrea Agent
 connects to the Controller API server and watches the computed NetworkPolicy
 objects. Controller also exposes a REST API for `antctl` on the same HTTP
 endpoint. See more information about the Controller API server implementation
-in the [Controller API server section](#Controller-API-server).
+in the [Controller API server section](#controller-api-server).
 
 #### Controller API server
 

docs/design/ovs-pipeline.md

@@ -1175,13 +1175,13 @@ traffic to the next table, [AntreaPolicyEgressRuleTable].
 [ClassifierTable]: #classifiertable-0
 [SpoofGuardTable]: #spoofguardtable-10
 [ARPResponderTable]: #arprespondertable-20
-[ServiceHairpinTable]: #serviceHairpinTable-23
+[ServiceHairpinTable]: #servicehairpintable-23
 [ConntrackTable]: #conntracktable-30
 [ConntrackStateTable]: #conntrackstatetable-31
 [DNATTable]: #dnattable-40
-[SessionAffinityTable]: #sessionAffinityTable-40
-[ServiceLBTable]: #serviceLBTable-41
-[EndpointDNATTable]: #endpointDNATTable-42
+[SessionAffinityTable]: #sessionaffinitytable-40
+[ServiceLBTable]: #servicelbtable-41
+[EndpointDNATTable]: #endpointdnattable-42
 [AntreaPolicyEgressRuleTable]: #antreapolicyegressruletable-45
 [EgressRuleTable]: #egressruletable-50
 [EgressDefaultTable]: #egressdefaulttable-60
@@ -1193,5 +1193,5 @@ traffic to the next table, [AntreaPolicyEgressRuleTable].
 [IngressRuleTable]: #ingressruletable-90
 [IngressDefaultTable]: #ingressdefaulttable-100
 [ConntrackCommitTable]: #conntrackcommittable-105
-[HairpinSNATTable]: #hairpinSNATTable-108
+[HairpinSNATTable]: #hairpinsnattable-108
 [L2ForwardingOutTable]: #l2forwardingouttable-110

docs/getting-started.md

@@ -140,7 +140,7 @@ following:
 2. Delete Flannel bridge and tunnel interface with `ip link delete flannel.1 &&
 ip link delete flannel cni0` **on each Node**.
 3. Ensure [requirements](#ensuring-requirements-are-satisfied) are satisfied.
-4. [Deploy Antrea](#installation).
+4. [Deploy Antrea](#installation--upgrade).
 5. Drain and uncordon Nodes one-by-one. For each Node, run `kubectl drain
 --ignore-daemonsets <node name> && kubectl uncordon <node name>`. The
 `--ignore-daemonsets` flag will ignore DaemonSet-managed Pods, including the

docs/windows.md

@@ -50,7 +50,7 @@ management Pods. It is recommended to run OVS daemons as Windows services.
 We also support running OVS processes inside a container. If you don't want to
 run antrea-agent and kube-proxy from the management Pods Antrea also provides
 scripts which help to install and run these two components directly without Pod.
-Please see [Manually run kube-proxy and antrea-agent on Windows worker Nodes](#Manually-run-kube-proxy-and-antrea-agent-on-Windows-worker-Nodes)
+Please see [Manually run kube-proxy and antrea-agent on Windows worker Nodes](#manually-run-kube-proxy-and-antrea-agent-on-windows-worker-nodes)
 section for details.
 
 ### Antrea Windows demo
@@ -72,7 +72,7 @@ the Windows Nodes in the demo.
 * Install [Hyper-V](https://docs.microsoft.com/en-us/windows-server/virtualization/hyper-v/get-started/install-the-hyper-v-role-on-windows-server)
   with management tools. If your Nodes do not have the virtualization
   capabilities required by Hyper-V, you could try the workaround
-  described in the [Known issues](#Known-issues) section.
+  described in the [Known issues](#known-issues) section.
 * Install [Docker](https://docs.microsoft.com/en-us/virtualization/windowscontainers/quick-start/set-up-environment?tabs=Windows-Server).
 * [Install OVS](https://docs.openvswitch.org/en/latest/intro/install/windows/)
   and configure the daemons as Windows service.
@@ -81,7 +81,7 @@ the Windows Nodes in the demo.
     [install a test-signed driver package on the test computer](https://docs.microsoft.com/en-us/windows-hardware/drivers/install/installing-a-test-signed-driver-package-on-the-test-computer).
   - If you don't have a self-signed OVS package and just want to try the
     Antrea on Windows, Antrea provides a test-signed OVS package for you.
-    See details in [Join Windows worker Nodes](#Join-Windows-worker-nodes)
+    See details in [Join Windows worker Nodes](#join-windows-worker-nodes)
     section.
 * Some manifests are from [sig-windows-tool](https://github.com/kubernetes-sigs/sig-windows-tools)
   repo. Release version v0.1.5 has been verified.
@@ -437,7 +437,7 @@ kube-proxy-windows-2d45w                               1/1     Running     0
 Starting from Kubernetes 1.26, Antrea will no longer support Windows kube-proxy
 because kube-proxy userspace mode is deprecated and kernelspace mode does not
 work with Antrea. For a cluster with Kubernetes version 1.26 or later, please
-refer to [Deploying Antrea on Windows Worker Node](#Deploying-Antrea-on-Windows-Worker-Node)
+refer to [Deploying Antrea on Windows Worker Node](#deploying-antrea-on-windows-worker-node)
 
 First, deploy a Windows-compatible version of kube-proxy. You can download `kube-proxy.yaml`
 from the Kubernetes github repository to deploy kube-proxy. The kube-proxy version
@@ -559,10 +559,9 @@ kubectl apply -f kube-proxy.yml
 
 Aside from starting kube-proxy and antrea-agent from the management Pods, Antrea
 also provides powershell scripts which help install and run these two components
-directly without Pod. Please complete the steps in [Installation](#Installation)
-section, skip [Add Windows kube-proxy DaemonSet](#Add-Windows-kube-proxy-DaemonSet)
-and [Add Windows antrea-agent DaemonSet](#Add-Windows-antrea-agent-DaemonSet)
-steps. And then run the following commands in powershell.
+directly without Pod. Please complete the steps in [Installation](#installation-as-a-pod-dockercontainerd-based-runtimes)
+section, and skip the [Add Windows antrea-agent DaemonSet](#add-windows-antrea-agent-daemonset)
+step. And then run the following commands in powershell.
 
 ```powershell
 mkdir c:\k\antrea