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

doc: fixes wrong identation in a code block #14108

Closed
wants to merge 1 commit into from

Conversation

Brice187
Copy link

Checklist:

  • Commit Message Formatting: Commit titles and messages follow guidelines in the developer guide.
  • Reviewed the developer guide on Submitting a Pull Request
  • Pending release notes updated with breaking and/or notable changes for the next minor release. <- Just fixed a small typo, not worth to mention
  • Documentation has been updated, if necessary.
  • Unit tests have been added, if necessary.
  • Integration tests have been added, if necessary.

Small fix

Wrong formatting in the docs (You should not see 3 backticks and the reserved keyword YAML):

image

Copy link
Member

@travisn travisn left a comment

Choose a reason for hiding this comment

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

Please see the first point in the PR checklist:

  • Commit Message Formatting: Commit titles and messages follow guidelines in the developer guide

The Commitlint and DCO CI actions are failing because the commit message needs to follow this pattern.

Thanks for submitting the fix!

@@ -80,12 +80,12 @@ echo "http://$(kubectl -n rook-ceph -o jsonpath={.status.hostIP} get pod prometh

Following is an example to configure the Prometheus endpoint in the CephCluster CR.

```YAML
```YAML
Copy link
Member

Choose a reason for hiding this comment

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

Interesting that later in the doc there are similar instances, but they are rendered properly, perhaps because they under under bulleted points.

@Brice187 Brice187 changed the title docs: fixes wrong identation in a code block doc: fixes wrong identation in a code block Apr 23, 2024
Copy link

mergify bot commented May 1, 2024

This pull request has merge conflicts that must be resolved before it can be merged. @Brice187 please rebase it. https://rook.io/docs/rook/latest/Contributing/development-flow/#updating-your-fork

@Brice187 Brice187 closed this May 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants