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

Add color hints to text blocks, use explicit <br> instead of whitespace #330

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

C0rn3j
Copy link
Contributor

@C0rn3j C0rn3j commented Oct 16, 2024

Fixes up the coloring of code blocks.

Unifies some of the code blocks (there was a file with triple backticks for the first command, but used single backtick format for the rest).

Fixes a syntax error in objects.md where it used quadruple backticks once.

Converts whitespace line breaks to explicit <br> tags, as whitespace can be inconsistent and people can randomly litter it on accident - which is exactly the case of some of the touched up files.

Note that the shell commands remain mostly uncolored, but I tagged them anyway, as some editors do support the tags, even if GitHub doesn't.

Is adding a changelog fragment necessary for just a doc change?

Also fixes a syntax error in objects.md where it used quadruple backticks once
Copy link

cla-bot bot commented Oct 16, 2024

Thank you for your pull request. Before we can look at it, you'll need to sign a Contributor License Agreement (CLA).

Please follow instructions at https://icinga.com/company/contributor-agreement to sign the CLA.

After that, please reply here with a comment and we'll verify.

Contributors that have not signed yet: @C0rn3j

  • If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Please contact us if you think this is the case.

  • If you signed the CLA as a corporation, your GitHub username may not have been submitted to us. Please reach out to the responsible person in your organization.

@C0rn3j
Copy link
Contributor Author

C0rn3j commented Oct 16, 2024

CLA signed.

@bobapple
Copy link
Member

@cla-bot check

@cla-bot cla-bot bot added the cla/signed label Oct 16, 2024
@mkayontour
Copy link
Member

Hi sorry, for the late reply. I can add the changelog later on, the changelog will created automatically based on the fragments. So it's easier to keep track over the changes and also highlight contributors in the release notes. ;)

This looks good to me.

Copy link
Collaborator

@Donien Donien left a comment

Choose a reason for hiding this comment

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

Thank you very much for your work and getting rid off these pesky little trailing whitespaces!

Just apply the suggestions. Other than that we're good. Thanks :)

doc/plugins/inventory/icinga-inventory-plugin.md Outdated Show resolved Hide resolved
doc/plugins/inventory/icinga-inventory-plugin.md Outdated Show resolved Hide resolved
doc/role-monitoring_plugins/role-monitoring_plugins.md Outdated Show resolved Hide resolved
@C0rn3j
Copy link
Contributor Author

C0rn3j commented Nov 16, 2024

@Donien Thanks for the review, I've applied all the suggestions

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants