-
Notifications
You must be signed in to change notification settings - Fork 67
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 Getting Started guide #624
Conversation
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.
Great! I would have been happy to have this getting started in the past.
Perhaps it would be worth to also mention theses JUnit 5 configurations:
https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/f0c25aecd006262929668f04d836309e3b3b071b/smoke-tests-otel-starter/spring-boot-reactive-3/build.gradle.kts#L65
It would be great if you could create a Github repository with the getting started code.
### Agent filter file | ||
|
||
Filter files that agent consumes in the `conditional` mode have the following structure: | ||
``` |
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.
Use ```json
``` | ||
{{ | ||
"resources":{ | ||
"includes":[{ |
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.
We should use the new format here.
I am extremely confused. We already have a getting started guide. It's even mentioned in the README and is published alongside the release: https://graalvm.github.io/native-build-tools/latest/gradle-plugin-quickstart.html Why are we adding another one instead, if needed, to fix the other one? |
The getting started of this PR provides useful additional information, such an agent example with the conditional mode. |
But why creating a new guide? The old one should be fixed. Now we have 2, and this one is inconsistently published (.md file instead of generated, versioned docs). |
Agree |
This is a simplified guide where one comes and sees the exact steps they need to do to support a library. What other guide do we have? I am aware of our docs, but I feel they are more of reference manual. |
On the GitHub home page, we have: This links to https://graalvm.github.io/native-build-tools/latest/gradle-plugin-quickstart.html which is also crossed referenced from the reference documentation: https://graalvm.github.io/native-build-tools/latest/gradle-plugin.html#quickstart Both quickstart guide and reference docs are generated by asciidoctor: https://github.com/graalvm/native-build-tools/tree/db65d975c6e05ccd1f5d9f0bf7ddb163e7866691/docs/src/docs/asciidoc |
I think that we can fuse this guide with the existing one. Existing one misses few points explained in this guide (like agent modes, how to pass runtime/buildtime options, slightly more details about Another important point is accessibility of the guide. I think it should be one of the first items on the main docs page. At the moment it looks a bit hidden. |
Yes, I think the main page deserves a revamp. Especially now that there are so many releases, having the changelog as the TOC doesn't quite make sense anymore. |
Changes included in: #645 |
This PR adds a guide that shows how newcomers can start using Native Gradle Plugin