Skip to content

K8's metric tables are not rendering as expected with content split over multiple lines #3073

@thompson-tomo

Description

@thompson-tomo

Area(s)

area:k8s

What's the problem?

When i look at k8s metrics the content is not being rendered correctly, An example of this is https://github.com/open-telemetry/semantic-conventions/blob/main/docs/system/k8s-metrics.md#metric-k8sresourcequotaobject_countused & https://opentelemetry.io/docs/specs/semconv/system/k8s-metrics/#metric-k8sresourcequotaobject_countused

When I turned off markdownlint suppression in the sample the below errors were produced:

docs/system/k8s-metrics.md:2219:14 MD034/no-bare-urls Bare URL used [Context: "https://kubernetes.io/docs/ref..."]
docs/system/k8s-metrics.md:2241:14 MD034/no-bare-urls Bare URL used [Context: "https://kubernetes.io/docs/ref..."]
docs/system/k8s-metrics.md:2263:14 MD034/no-bare-urls Bare URL used [Context: "https://kubernetes.io/docs/ref..."]
docs/system/k8s-metrics.md:2285:14 MD034/no-bare-urls Bare URL used [Context: "https://kubernetes.io/docs/ref..."]
docs/system/k8s-metrics.md:2307:14 MD034/no-bare-urls Bare URL used [Context: "https://kubernetes.io/docs/ref..."]
docs/system/k8s-metrics.md:2329:14 MD034/no-bare-urls Bare URL used [Context: "https://kubernetes.io/docs/ref..."]
docs/system/k8s-metrics.md:2351:14 MD034/no-bare-urls Bare URL used [Context: "https://kubernetes.io/docs/ref..."]
docs/system/k8s-metrics.md:2373:14 MD034/no-bare-urls Bare URL used [Context: "https://kubernetes.io/docs/ref..."]
docs/system/k8s-metrics.md:2446:104 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe]
docs/system/k8s-metrics.md:2446:104 MD056/table-column-count Table column count [Expected: 6; Actual: 4; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2447:1 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: trailing_only; Missing leading pipe]
docs/system/k8s-metrics.md:2447:226 MD056/table-column-count Table column count [Expected: 6; Actual: 3; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2470:104 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe]
docs/system/k8s-metrics.md:2470:104 MD056/table-column-count Table column count [Expected: 6; Actual: 4; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2471:1 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: trailing_only; Missing leading pipe]
docs/system/k8s-metrics.md:2471:232 MD056/table-column-count Table column count [Expected: 6; Actual: 3; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2494:108 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe]
docs/system/k8s-metrics.md:2494:108 MD056/table-column-count Table column count [Expected: 6; Actual: 4; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2495:1 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: trailing_only; Missing leading pipe]
docs/system/k8s-metrics.md:2495:226 MD056/table-column-count Table column count [Expected: 6; Actual: 3; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2518:108 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe]
docs/system/k8s-metrics.md:2518:108 MD056/table-column-count Table column count [Expected: 6; Actual: 4; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2519:1 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: trailing_only; Missing leading pipe]
docs/system/k8s-metrics.md:2519:232 MD056/table-column-count Table column count [Expected: 6; Actual: 3; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2542:107 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe]
docs/system/k8s-metrics.md:2542:107 MD056/table-column-count Table column count [Expected: 6; Actual: 4; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2543:1 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: trailing_only; Missing leading pipe]
docs/system/k8s-metrics.md:2543:226 MD056/table-column-count Table column count [Expected: 6; Actual: 3; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2566:107 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe]
docs/system/k8s-metrics.md:2566:107 MD056/table-column-count Table column count [Expected: 6; Actual: 4; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2567:1 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: trailing_only; Missing leading pipe]
docs/system/k8s-metrics.md:2567:232 MD056/table-column-count Table column count [Expected: 6; Actual: 3; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2590:111 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe]
docs/system/k8s-metrics.md:2590:111 MD056/table-column-count Table column count [Expected: 6; Actual: 4; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2591:1 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: trailing_only; Missing leading pipe]
docs/system/k8s-metrics.md:2591:226 MD056/table-column-count Table column count [Expected: 6; Actual: 3; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2614:111 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe]
docs/system/k8s-metrics.md:2614:111 MD056/table-column-count Table column count [Expected: 6; Actual: 4; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2615:1 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: trailing_only; Missing leading pipe]
docs/system/k8s-metrics.md:2615:232 MD056/table-column-count Table column count [Expected: 6; Actual: 3; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2638:130 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe]
docs/system/k8s-metrics.md:2638:130 MD056/table-column-count Table column count [Expected: 6; Actual: 4; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2639:1 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: trailing_only; Missing leading pipe]
docs/system/k8s-metrics.md:2639:226 MD056/table-column-count Table column count [Expected: 6; Actual: 3; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2668:130 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe]
docs/system/k8s-metrics.md:2668:130 MD056/table-column-count Table column count [Expected: 6; Actual: 4; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2669:1 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: trailing_only; Missing leading pipe]
docs/system/k8s-metrics.md:2669:232 MD056/table-column-count Table column count [Expected: 6; Actual: 3; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2698:113 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe]
docs/system/k8s-metrics.md:2698:113 MD056/table-column-count Table column count [Expected: 6; Actual: 4; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2699:1 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: trailing_only; Missing leading pipe]
docs/system/k8s-metrics.md:2699:226 MD056/table-column-count Table column count [Expected: 6; Actual: 3; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2734:113 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe]
docs/system/k8s-metrics.md:2734:113 MD056/table-column-count Table column count [Expected: 6; Actual: 4; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2735:1 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: trailing_only; Missing leading pipe]
docs/system/k8s-metrics.md:2735:232 MD056/table-column-count Table column count [Expected: 6; Actual: 3; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2770:176 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe]
docs/system/k8s-metrics.md:2770:176 MD056/table-column-count Table column count [Expected: 6; Actual: 4; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2771:1 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: trailing_only; Missing leading pipe]
docs/system/k8s-metrics.md:2771:155 MD056/table-column-count Table column count [Expected: 6; Actual: 3; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2806:176 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe]
docs/system/k8s-metrics.md:2806:176 MD056/table-column-count Table column count [Expected: 6; Actual: 4; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2807:1 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: trailing_only; Missing leading pipe]
docs/system/k8s-metrics.md:2807:161 MD056/table-column-count Table column count [Expected: 6; Actual: 3; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2842:139 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe]
docs/system/k8s-metrics.md:2842:139 MD056/table-column-count Table column count [Expected: 6; Actual: 4; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2843:1 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: trailing_only; Missing leading pipe]
docs/system/k8s-metrics.md:2843:226 MD056/table-column-count Table column count [Expected: 6; Actual: 3; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2866:139 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe]
docs/system/k8s-metrics.md:2866:139 MD056/table-column-count Table column count [Expected: 6; Actual: 4; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2867:1 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: trailing_only; Missing leading pipe]
docs/system/k8s-metrics.md:2867:232 MD056/table-column-count Table column count [Expected: 6; Actual: 3; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2890:135 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe]
docs/system/k8s-metrics.md:2890:135 MD056/table-column-count Table column count [Expected: 6; Actual: 4; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2891:1 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: trailing_only; Missing leading pipe]
docs/system/k8s-metrics.md:2891:226 MD056/table-column-count Table column count [Expected: 6; Actual: 3; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2914:135 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe]
docs/system/k8s-metrics.md:2914:135 MD056/table-column-count Table column count [Expected: 6; Actual: 4; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2915:1 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: trailing_only; Missing leading pipe]
docs/system/k8s-metrics.md:2915:232 MD056/table-column-count Table column count [Expected: 6; Actual: 3; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2938:119 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe]
docs/system/k8s-metrics.md:2938:119 MD056/table-column-count Table column count [Expected: 6; Actual: 4; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2939:1 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: trailing_only; Missing leading pipe]
docs/system/k8s-metrics.md:2939:226 MD056/table-column-count Table column count [Expected: 6; Actual: 3; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2970:119 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe]
docs/system/k8s-metrics.md:2970:119 MD056/table-column-count Table column count [Expected: 6; Actual: 4; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2971:1 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: trailing_only; Missing leading pipe]
docs/system/k8s-metrics.md:2971:232 MD056/table-column-count Table column count [Expected: 6; Actual: 3; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2668:119 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe]
docs/system/k8s-metrics.md:2668:119 MD056/table-column-count Table column count [Expected: 6; Actual: 4; Too few cells, row will be missing data]
docs/system/k8s-metrics.md:2669:1 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: trailing_only; Missing leading pipe]
docs/system/k8s-metrics.md:2669:232 MD056/table-column-count Table column count [Expected: 6; Actual: 3; Too few cells, row will be missing data]

Describe the solution you'd like

The tables and content rendered as expected.

Additional context

#3074 reduces suppression of linting to catch these issues going forward.

Tip

React with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding +1 or me too, to help us triage it. Learn more here.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status

    No status

    Status

    Need triage

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions