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

Badge - compatibility with MD syntax #19

Merged
merged 1 commit into from
Mar 5, 2024

Conversation

Kielek
Copy link
Contributor

@Kielek Kielek commented Mar 5, 2024

Description

Possibility to add actuated.dev badge using markdown syntax.

Motivation and Context

  • I have raised an issue to propose this change (required)

Fixes: #18

PR for OpenTelemetry Automatic Instrumentation introducing support for ARM64. open-telemetry/opentelemetry-dotnet-instrumentation#3277

Current requirements, force us to allow html syntax in documentation files. If possible, it will be great to avoid this.

One of the solutions is to use common shields.io system to generate badges, alternatively you could add badge image in the proper size (120px) and support something like:

[![Arm CI sponsored by Actuated](https://docs.actuated.dev/images/actuated-badge-120.png)](https://actuated.dev/)

How Has This Been Tested?

Snippet from PR, here:
Arm CI sponsored by Actuated

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality), just documentation
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I've read the CONTRIBUTION guide
  • I have signed-off my commits with git commit -s

Signed-off-by: Piotr Kiełkowicz <[email protected]>
@derek derek bot added the new-contributor label Mar 5, 2024
@Kielek
Copy link
Contributor Author

Kielek commented Mar 5, 2024

@alexellis, FYI

Copy link
Member

@alexellis alexellis left a comment

Choose a reason for hiding this comment

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

LGTM

@alexellis alexellis merged commit dabe463 into self-actuated:master Mar 5, 2024
@alexellis
Copy link
Member

Thanks for the PR

@Kielek Kielek deleted the md-badge-support branch March 6, 2024 05:30
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.

Badge - better support for MD syntax
2 participants