FFFF
Skip to content

fix: add missing blank lines around shortcode alert content#1145

Open
nicknikolakakis wants to merge 1 commit intoetcd-io:mainfrom
nicknikolakakis:fix/1144-shortcode-alert-formatting
Open

fix: add missing blank lines around shortcode alert content#1145
nicknikolakakis wants to merge 1 commit intoetcd-io:mainfrom
nicknikolakakis:fix/1144-shortcode-alert-formatting

Conversation

@nicknikolakakis
Copy link
Copy Markdown
@nicknikolakakis nicknikolakakis commented Apr 9, 2026 •
edited
Loading

Summary

  • Fix 116 misformatted alert shortcodes across 28 files in v3.4, v3.5, v3.6, and v3.7 docs
  • Add required blank lines between opening/closing {{% alert %}} tags and their content
  • Hugo requires these blank lines for correct rendering (see Quickstart page appears to be broken #1140 for context)

Files by version

Version Files Fixes
v3.4 2 4
v3.5 3 16
v3.6 17 76
v3.7 6 20

Before

{{% alert title="Note" color="info" %}}
Content immediately after opening tag.
{{% /alert %}}

After

{{% alert title="Note" color="info" %}}

Content with required blank line separators.

{{% /alert %}}

Fixes #1144

@k8s-ci-robot
Copy link
Copy Markdown
k8s-ci-robot commented Apr 9, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: nicknikolakakis
Once this PR has been reviewed and has the lgtm label, please assign spzala for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot
Copy link
Copy Markdown
k8s-ci-robot commented Apr 9, 2026

Hi @nicknikolakakis. Thanks for your PR.

I'm waiting for a etcd-io member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@nicknikolakakis
fix: add missing blank lines around shortcode alert content
27339a2 
Hugo requires blank lines between alert shortcode tags and their
content. Without them, the alert content is not rendered correctly.

Fixes etcd-io#1144

Signed-off-by: Nick Nikolakakis <nonicked@protonmail.com>
@nicknikolakakis nicknikolakakis force-pushed the fix/1144-shortcode-alert-formatting branch from cf17c39 to 27339a2 Compare April 9, 2026 04:36
@spzala
Copy link
Copy Markdown
Member
spzala commented Apr 9, 2026

/ok-to-test

@jberkus
Copy link
Copy Markdown
Contributor
jberkus commented Apr 14, 2026

Hey, it doesn't look like the blank lines are actually required, just the line breaks. #1144 didn't ask for blank lines.

As such, I'm going to keep this open until our next docs meeting so we can decide if we want those extra lines there anyways, or not -- we might decide that it's good source formatting and merge your PR anyways.

/hold

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

do-not-merge/hold ok-to-test size/L

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Find any additional shortcode alerts and fix them

4 participants

@nicknikolakakis @k8s-ci-robot @spzala @jberkus
0