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

Update examples for Java 21, add Kotlin DSL gradle example #143

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

xenoterracide
Copy link

Fixes #142
Fixes #107

@xenoterracide xenoterracide changed the title Update Gradle examples in README Update examples for Java 21, add Kotlin DSL gradle example Nov 26, 2024
@xenoterracide
Copy link
Author

I made some changes after opening, you should squash the commits in the UI and I'd probably include the "fixes #" in that message

@abelsromero
Copy link
Member

Thanks @xenoterracide!
I see now the problem. The issue imo is more that we forgot to update the README once we migrated docs to the generate site with Antora. The docs there are correct while readme only contains Java 11 https://docs.asciidoctor.org/asciidoclet/latest/usage/.

I'd rather remove duplication than add to it, we could remove Usage and Additional features from the README and simply link to the antora docs in the introduction.

@xenoterracide
Copy link
Author

yeah, fair, I don't know where that code lives (haven't looked), and we still need a kotlin DSL example. It can be quite different... and is now the default when you generate a gradle project. Yay that kotlin.dcl is coming so eventually you'll need a 3rd format too... that bridge isn't really ready to cross though.

I don't know if that source has a way that allows you to select the language shown like gradle docs and some spring docs have, I'm guessing no.

should I update this PR? and and/or send a new one to those docs?

@abelsromero
Copy link
Member

abelsromero commented Nov 28, 2024

yeah, fair, I don't know where that code lives

Totally my mistake for not linking. It's a bit nested in docs dir, here it is https://github.com/asciidoctor/asciidoclet/blob/main/docs/modules/ROOT/pages/usage.adoc.

we still need a kotlin DSL example

I agree, it can be added next to the Gradle Groovy config for now. We could add "tabs" to the docs, but that needs to be done upstream in the docs aggregator repo. It's not something we can do autonomously now.

should I update this PR? and and/or send a new one to those docs?

Updating this is fine, I can take take of the squash from UI also.

thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

incorrect exports/opens kotlin example for gradle
2 participants