-
Notifications
You must be signed in to change notification settings - Fork 133
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
fix docs for MDX3 #575
Conversation
Signed-off-by: Arhell <[email protected]>
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: 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 |
There was a problem hiding this 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. |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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>
Merge? |
@windsonsea #575 (comment) yes. There are a lot of such files, I do a little at a time. |
What type of PR is this?
Add one of the following kinds:
/kind bug
/kind cleanup
/kind documentation
/kind feature