graalvm
Add Getting Started guide
This PR adds a guide that shows how newcomers can start using Native Gradle Plugin
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).
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.
What other guide do we have?
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 metadataCopy task, how to run tests in the CI...).
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. cc @melix
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: https://github.com/graalvm/native-build-tools/pull/645