open-telemetry
✅ [outreachy] Add more quick installations to the registry
This pull request fixes #5308 and adds quick installation for okHTTP Instrumentation
@svrnm am I supposed to make a change in quick install? I followed the same format in the entry.html however, it's showing compose require opentelemetry-instrumentation-okhttp instead of mvn install --. Additionally the the font awesome icon I added is not showing. Below is my output locally:
I would appreciate your guidance on this. Thanks.
@svrnm am I supposed to make a change in quick install? I followed the same format in the entry.html however, it's showing
compose require opentelemetry-instrumentation-okhttpinstead ofmvn install --. Additionally the the font awesome icon I added is not showing. Below is my output locally:
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 composer and not mvn
https://deploy-preview-5330--opentelemetry.netlify.app/ecosystem/registry/?s=okhttp&component=&language=
works in the preview, maybe some local caching issue
https://deploy-preview-5330--opentelemetry.netlify.app/ecosystem/registry/?s=okhttp&component=&language=
works in the preview, maybe some local caching issue
@svrnm I ran npm run build again, and then npm run serve and It worked. Here's my output locally:
@svrnm I noticed that the package information can be accessed using .<key> just like it was used in collector.md and hex.md and Hugo's split function uses a delimiter to separate strings and present them in the form of lists. Since the package name is io.opentelemetry.instrumentation/opentelemetry-okhttp-3.0 the spilt function converts it to ["io.opentelemetry.instrumentation", "opentelemetry-okhttp-3.0"] with \ as the delimiter.
Using Go's index function I was able to represent io.opentelemetry.instrumentation as the groupID and opentelemetry-okhttp-3.0 as the artifactID; and then reference it in entry.html. Below is my output locally:
I also removed installLine since it was doing something else.
lgtm overall, can you do the following please to fix the remaining CI issues:
- update your branch with the latest commit to main
- run npm run fix:all locally and commit the changes.
After you have done that, I would see this task as completed.
If you are open for an extra challenge, there is one more thing you can do: throughout the OpenTelemetry Java Documentation we provide instructions for Maven & Gradle, e.g. here is an example: https://opentelemetry.io/docs/languages/java/instrumentation/#dependency-management, and here you see how it is implemented using tabs: https://github.com/open-telemetry/opentelemetry.io/blob/main/content/en/docs/languages/java/instrumentation.md#dependency-management
So maybe you can update your could to support the maven snippet (that you have already) and the Gradle one, as listed here: https://central.sonatype.com/artifact/io.opentelemetry.instrumentation/opentelemetry-okhttp-3.0?smo=true by providing tabs as outlined above.
@mercybassey, apologies, but I just realized that you can not use shortcodes in that partial. This is a limitation of hugo I was running into multiple times already! This is not trivial to work around unfortunately, as you would need to replicate the whole tabbing logic. The easiest solution is just having gradle and maven below each other and stating that in a few sentences.
Hi @svrnm I'm currently facing an issue when adding the tabs. I made the existing code snippet for Maven appear in a tab to see how it looks locally before adding the code snippets for Gradle. When I run npm run fix:all or npm run build I get the following error message:
Total in 33 ms Error: error copying static files: "/home/mercy/opentelemetry.io/layouts/partials/ecosystem/registry/quickinstall/maven.md:3:1": parse failed: template: partials/ecosystem/registry/quickinstall/maven.md:3: unexpected "%" in command
I noticed that opentelemetry.io uses the Docsy theme, so I followed the guide here. But I still cannot bypass or resolve the above error.
I'd appreciate your help on this. Thanks.
@mercybassey, apologies, but I just realized that you can not use shortcodes in that partial. This is a limitation of hugo I was running into multiple times already! This is not trivial to work around unfortunately, as you would need to replicate the whole tabbing logic. The easiest solution is just having gradle and maven below each other and stating that in a few sentences.
Okay. I'll do just that.
@mercybassey, apologies, but I just realized that you can not use shortcodes in that partial. This is a limitation of hugo I was running into multiple times already! This is not trivial to work around unfortunately, as you would need to replicate the whole tabbing logic. The easiest solution is just having gradle and maven below each other and stating that in a few sentences.
Okay. I'll do just that.
@svrnm I have added the code snippets for gradle, gradle(short) and gradle(kotlin). I'd like to know what you think. Thanks.
I also ran
npm run fix:allbut some CI jobs are still failing.
it looks like maven does not like our crawler that we use to verify that their page is valid. That's out of scope for you to fix, let me do that for you.
I'd like to know what you think. Thanks.
It looks really great, thank you!
@mercybassey I added a fix for the CI issue, if you run git pull locally you should have that change as well.
Thank you @mercybassey! This looks really good, I consider this as done! After the outreachy application phase we will take another look and see if we can merge this PR.
Thank you @mercybassey! This looks really good, I consider this as done! After the outreachy application phase we will take another look and see if we can merge this PR.
Thank you.