Skip to content

docs: fix md syntax to correctly display on webpage #20681

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Kairixir
Copy link

the content in the official documentation's HTML rendering has broken formatting

before:

image

after:

fixed

the content in the official documentation's HTML rendering has broken formatting
Copy link

CLA Not Signed

@k8s-ci-robot
Copy link
Contributor

Welcome @Kairixir!

It looks like this is your first PR to kubernetes/minikube 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/minikube has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot requested a review from spowelljr April 29, 2025 10:04
@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Apr 29, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @Kairixir. Thanks for your PR.

I'm waiting for a kubernetes 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.

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.

@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Apr 29, 2025
@minikube-bot
Copy link
Collaborator

Can one of the admins verify this patch?

Copy link
Member

@ComradeProgrammer ComradeProgrammer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screenshot 2025-04-30 at 01 09 44
Great job. It is indeed fixed! Thanks for your contribution.

But in order to get this PR merged, you have to sign CLA. Please follow the instructions of bot linux-foundation-easycla, which is the 2nd comment in this PR's conversation. It is mandatory for every contributor of k8s, very simple and quick, just some clicks.

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 29, 2025
@medyagh
Copy link
Member

medyagh commented Apr 30, 2025

@Kairixir please make sure to Sign the CLA, otherwise we cant merge this PR

@serut
Copy link

serut commented May 5, 2025

I've made the same MR with more pages : #20705

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ComradeProgrammer, Kairixir, medyagh

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

The pull request process is described here

Needs approval from an approver in each of these files:
  • OWNERS [ComradeProgrammer,medyagh]

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

@medyagh
Copy link
Member

medyagh commented May 19, 2025

@serut do you mind signing the CLA so I can merge this PR ?

@medyagh
Copy link
Member

medyagh commented May 19, 2025

@ComradeProgrammer lets make sure contributors sign the CLA before approving the PRs

@serut
Copy link

serut commented May 19, 2025

@serut do you mind signing the CLA so I can merge this PR ?

My MR is here : #20705
I've already signed CLA

@serut
Copy link

serut commented May 21, 2025

@Kairixir

As mentionned in #20705, this MR #20681 can now be closed as the original issue was related to hugo version and disappeared when hugo was upgraded from v0.146.6 to v0.147.1 #20700

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants