Skip to content
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

fix docs for MDX3 #575

Closed
wants to merge 1 commit into from
Closed

fix docs for MDX3 #575

wants to merge 1 commit into from

Conversation

Arhell
Copy link
Member

@Arhell Arhell commented Mar 6, 2024

What type of PR is this?

Add one of the following kinds:

/kind bug
/kind cleanup
/kind documentation
/kind feature

Signed-off-by: Arhell <[email protected]>
@karmada-bot karmada-bot added kind/bug Categorizes issue or PR as related to a bug. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. labels Mar 6, 2024
@karmada-bot karmada-bot requested review from Poor12 and samzong March 6, 2024 17:01
@karmada-bot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is NOT APPROVED

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

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

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

@karmada-bot karmada-bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Mar 6, 2024
Copy link
Member Author

@Arhell Arhell left a comment

Choose a reason for hiding this comment

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

@@ -407,7 +407,7 @@ In this case, you will use Gatekeeper v3.7.2. Related deployment files are from
name: kubeconfig
namespace: gatekeeper-system
```
You need to fill in the dummy pod created in step 1 to {{ POD_NAME }} and fill in the secret which represents kubeconfig pointing to karmada-apiserver.
You need to fill in the dummy pod created in step 1 to \{\{ POD_NAME \}\} and fill in the secret which represents kubeconfig pointing to karmada-apiserver.
Copy link
Member

Choose a reason for hiding this comment

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

I wonder do we need a guide for people to write docs with MDX3 compliant?

Copy link
Member Author

Choose a reason for hiding this comment

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

I think yes, if we want to update to version 3.
As for me, you just need to wrap these variables {{ POD_NAME }} in something ***{{ POD_NAME }}*** for example or other ``` characters.

And it would be good to do something about this #565 (comment)
Because it could be a problem.

Copy link
Member

Choose a reason for hiding this comment

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

Perhaps we should integrate a syntax detection command into git commit, allowing users to identify issues promptly and receive appropriate solutions, thereby preventing collective confusion.

MDX3 appears to be more stringent than Markdown, and it's unclear whether this is advantageous.

Copy link
Member

Choose a reason for hiding this comment

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

`` seems more common in markdown like:

  • Example 1: {{ POD_NAME }}

  • Example 2:

    CLUSTER_NAME=<member_cluster_name>
    HOST_IP=<member_cluster_entry_ip>
    PORT=<member_cluster_entry_port>
    KUBECONFIG=<member_cluster_kubeconfig>
    

@Arhell
Copy link
Member Author

Arhell commented Apr 23, 2024

Merge?

@Arhell
Copy link
Member Author

Arhell commented Apr 23, 2024

@windsonsea #575 (comment) yes. There are a lot of such files, I do a little at a time.

@Arhell Arhell closed this Apr 27, 2024
@Arhell Arhell deleted the upd branch April 27, 2024 06:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Categorizes issue or PR as related to a bug. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants