-
-
Notifications
You must be signed in to change notification settings - Fork 1k
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
Broken code block on kubernetes/introduction.md #7270
Broken code block on kubernetes/introduction.md #7270
Conversation
Signed-off-by: Carlos Eduardo Magalhães <github@cadumagalhaes.dev>
Thanks for choosing to contribute @1cadumagalhaes. We lint all PR's with golangci-lint and eslint, I may add a review to your PR with some suggestions. You are free to apply the changes if you're comfortable, alternatively you are welcome to ask a team member for advice. ArtifactsThese changes once approved by a team member will be published for testing on Buildkite, DockerHub and GitHub Container Registry. Docker Container
|
WalkthroughThe recent update aims to enhance the presentation of the Kubernetes documentation by refining the formatting of a YAML code block within the Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
✅ Deploy Preview for authelia-staging ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
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.
Actionable comments posted: 1
@@ -53,8 +53,7 @@ is the default. This should be changed to `false`. See the | |||
for more details. | |||
|
|||
#### Pod Example | |||
|
|||
{title="pod.yml"} | |||
```yaml {title="pod.yml"} |
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.
Ensure there is a blank line before the YAML code block for proper Markdown formatting.
55a56
>
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
```yaml {title="pod.yml"} |
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.
Fix pushed in commit ef74fa8
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.
@1cadumagalhaes, thank you for the update. I've reviewed the changes in the commit ef74fa8
, and it appears that the YAML code block for the Pod example now correctly starts with a blank line, adhering to proper Markdown formatting. This should ensure that the documentation renders correctly on the website.
If there's anything else you need, feel free to ask!
Analysis chain
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Fetch the content of the file from the specific commit to verify the changes.
git show ef74fa87103e2b103ba5af940af58d8ce6f583cf:docs/content/integration/kubernetes/introduction.md
Length of output: 2883
If you found this review helpful, would you consider giving us a shout-out on X?
Thank you for using CodeRabbit!
Signed-off-by: Carlos Eduardo Magalhães <github@cadumagalhaes.dev>
Just a quick fix in the md, I tought it would be easier than to open an issue