-
Notifications
You must be signed in to change notification settings - Fork 1.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
[outreachy] Add more quick installations to the registry #5330
base: main
Are you sure you want to change the base?
[outreachy] Add more quick installations to the registry #5330
Conversation
@svrnm am I supposed to make a change in quick install? I followed the same format in the entry.html however, it's showing I would appreciate your guidance on this. Thanks. |
Also the spelling check job is failing, did I do something wrong? |
hey @mercybassey, good start! first of all, do not worry about the spell checker or any other issues, as long as the preview builds we are fine: https://deploy-preview-5330--opentelemetry.netlify.app/ Let me take a look why it shows |
works in the preview, maybe some local caching issue |
@svrnm I ran |
@@ -46,6 +46,11 @@ | |||
"installLine" "cargo add %s" | |||
"installTemplate" "ecosystem/registry/quickinstall/default.md" | |||
"icon" "fab fa-rust") | |||
"maven" (dict | |||
"urlPattern" "https://central.sonatype.com/%s" | |||
"installLine" "mvn install %s" |
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.
mvn install
does something different (https://maven.apache.org/plugins/maven-install-plugin/), what you will need to show is the snippet that someone needs to add to the pom.xml
to add the dependency, here
<dependency>
<groupId>io.opentelemetry.instrumentation</groupId>
<artifactId>opentelemetry-okhttp-3.0</artifactId>
<version>2.8.0-alpha</version>
</dependency>
To accomplish that you will need a custom file in quickinstall
, check the hex.md
and collector.md
how that can be done.
I suggest that for the name of the package you use io.opentelemetry.instrumentation/opentelemetry-okhttp-3.0
, that way the link will be correct. Note that you will face a challenge then with the XML file, since you need to split that name by the /
to distribute it across groupId
and artifactId
. Hugo has a split function for that.
Co-authored-by: Severin Neumann <[email protected]>
@svrnm I noticed that the package information can be accessed using Using Go's index function I was able to represent I also removed |
great work 👍 |
This pull request fixes #5308 and adds quick installation for
okHTTP Instrumentation