-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
Markdown cleanup: Replace {{< >}} with {{% %}} #6442
Conversation
The committers listed above are authorized under a signed CLA. |
@heidi04aldidi I don't find the rationale to replace the markup. Can you share the reason for this PR? |
The main reason for this change is to standardize the markdown syntax throughout the project. Using {{% %}} instead of {{< >}} creates a consistent look and behavior across all markdown files. The change could align with project or community standards and best practices for markdown syntax. Fixes #6442 |
The issue is actually: Have you read the contribution guidelines @heidi04aldidi? If not see, https://opentelemetry.io/docs/contributing/issues/#fixing-an-existing-issue. If the fix were just a search-and-replace it would have been done a while ago. Much more care is required. I suggest you read the contribution guidelines and choose a more appropriate issue to tackle, such as those labeled as good for first timers and help-wanted. |
Thank you for your feedback and pointing that out. I apologize for the confusion with the issue number in the PR description — I’ve now realized I referenced it incorrectly. I’ll make sure to correct it. I also understand that the fix is more complex than just a search-and-replace, and I’ll be sure to review the contribution guidelines carefully to avoid oversimplifying the changes. I'll go through the guidelines you mentioned and will choose a more appropriate issue to work on, especially those labeled "good for first timers" or "help-wanted." If you have any suggestions or specific guidance on how to approach this particular issue correctly, I’d really appreciate it. Thanks again for the constructive feedback! |
This pull request addresses the markdown syntax cleanup issue by replacing
{{< >}}
with{{% %}}
, as per the request in the issue.{{< >}}
with{{% %}}
in the markdown files.I am not a member of the organization, but I believe this change will help improve the project's documentation. Please let me know if any further modifications are needed.