fix: convert kramdown definition lists to HTML dl elements#2583
fix: convert kramdown definition lists to HTML dl elements#2583ctauchen merged 1 commit intotigera:mainfrom
Conversation
MDX/Docusaurus does not support the kramdown-style definition list syntax (term\n: definition). Convert all instances to standard HTML <dl>/<dt>/<dd> elements which render correctly in MDX without requiring any additional remark plugins. Affected files: - calico/networking/openstack/neutron-api.mdx - calico-cloud/reference/architecture/design/l3-interconnect-fabric.mdx - versioned copies of the above (3.29, 3.30, 3.31, calico-cloud-22-2) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
✅ Deploy Preview for calico-docs-preview-next ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview succeeded!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
This PR fixes a rendering issue where kramdown-style definition list syntax (term\n: definition) was being used in MDX files. Since Docusaurus/MDX does not support kramdown syntax, these definition lists rendered as plain text rather than structured definition lists. The fix converts them to standard HTML <dl>/<dt>/<dd> elements with appropriate inline HTML formatting.
Changes:
- Convert kramdown definition lists to HTML
<dl>/<dt>/<dd>elements in 6 files (2 source + 4 versioned copies), replacing markdown formatting inside the HTML blocks with equivalent HTML tags - Add a QoS documentation section backport to the version-3.29 neutron-api file (not mentioned in the PR description)
- Add Vale linting suppression comments to the version-22-2 l3-interconnect-fabric file to match the source file
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
calico/networking/openstack/neutron-api.mdx |
Convert 3 kramdown definition list blocks to HTML <dl> elements |
calico-cloud/reference/architecture/design/l3-interconnect-fabric.mdx |
Convert 1 kramdown definition list block (4 terms) to HTML <dl> element |
calico_versioned_docs/version-3.29/networking/openstack/neutron-api.mdx |
Convert definition lists + add new QoS section backport |
calico_versioned_docs/version-3.30/networking/openstack/neutron-api.mdx |
Convert 3 kramdown definition list blocks to HTML <dl> elements |
calico_versioned_docs/version-3.31/networking/openstack/neutron-api.mdx |
Convert 3 kramdown definition list blocks to HTML <dl> elements |
calico-cloud_versioned_docs/version-22-2/reference/architecture/design/l3-interconnect-fabric.mdx |
Convert definition list + add Vale suppression comments |
| ## QoS | ||
|
|
||
| Calico for OpenStack implements some Neutron QoS policy fields: the `max_kbps` | ||
| and `max_burst_kbps` fields of bandwidth limit rules, and the `max_kpps` field | ||
| of packet rate limit rules. Calico also honours the `direction` field of these | ||
| rules, so these limits can be set independently for both ingress and egress | ||
| directions. | ||
|
|
||
| :::note | ||
|
|
||
| There is uncertainty as to whether `max_burst_kbps` is intended to configure | ||
| the burst *rate* or the burst *size*. Calico interprets it as the burst *rate* | ||
| and honours `neutron.conf` fields for configuring the burst *size*. | ||
|
|
||
| ::: | ||
|
|
||
| There are also new Calico Neutron driver settings (cluster-wide, set in `neutron.conf`): | ||
|
|
||
| - `[calico] max_ingress_connections_per_port` for imposing a maximum number of | ||
| ingress connections per Neutron port, and | ||
|
|
||
| - `[calico] max_egress_connections_per_port` for imposing a maximum number of | ||
| egress connections per Neutron port. | ||
|
|
||
| - `[calico] ingress_burst_kbits`, if non-zero, configures the maximum allowed | ||
| burst at peakrate, in the ingress direction. | ||
|
|
||
| - `[calico] egress_burst_kbits`, if non-zero, configures the maximum allowed | ||
| burst at peakrate, in the egress direction. | ||
|
|
||
| - `[calico] ingress_minburst_bytes`, if non-zero, configures the minimum burst | ||
| size for peakrate data, in the ingress direction. | ||
|
|
||
| - `[calico] egress_minburst_bytes`, if non-zero, configures the minimum burst | ||
| size for peakrate data, in the egress direction. |
There was a problem hiding this comment.
The PR description says this PR only "converts kramdown definition lists to HTML dl elements" across the 6 listed files. However, this diff also adds an entirely new "## QoS" section (lines 143–177) to the version-3.29 file. This content backport is not mentioned in the PR summary or test plan. It would be helpful to document this additional change in the PR description so reviewers are aware of it and can verify the content is correct for version 3.29.
| {/* vale Vale.Repetition = NO */} | ||
| compute server, shares the same AS as the ToR that they are connected | ||
| {/* vale Vale.Repetition = YES */} |
There was a problem hiding this comment.
The PR description does not mention the addition of Vale linting suppression comments ({/* vale Vale.Repetition = NO/YES */}) in this file. While these are likely needed to suppress false-positive lint warnings, they should be noted in the PR description for completeness.
Summary
term\n: definition) to standard HTML<dl>/<dt>/<dd>elementsAffected files
calico/networking/openstack/neutron-api.mdx(4 definitions across 3<dl>blocks)calico-cloud/reference/architecture/design/l3-interconnect-fabric.mdx(4 definitions in 1<dl>block)calico_versioned_docs/version-3.29/networking/openstack/neutron-api.mdxcalico_versioned_docs/version-3.30/networking/openstack/neutron-api.mdxcalico_versioned_docs/version-3.31/networking/openstack/neutron-api.mdxcalico-cloud_versioned_docs/version-22-2/reference/architecture/design/l3-interconnect-fabric.mdxTest plan
🤖 Generated with Claude Code