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

build.gradle.kts compatible documentation #4106

Closed
tokuhirom opened this issue Feb 23, 2022 · 3 comments · Fixed by #4176
Closed

build.gradle.kts compatible documentation #4106

tokuhirom opened this issue Feb 23, 2022 · 3 comments · Fixed by #4176
Milestone

Comments

@tokuhirom
Copy link
Member

tokuhirom commented Feb 23, 2022

https://armeria.dev/docs/client-retrofit/

Currently, armeria docs was written in this form.

dependencies {
    implementation platform('com.linecorp.armeria:armeria-bom:1.14.1')

    ...
    implementation 'com.linecorp.armeria:armeria-retrofit2'
}

It's a valid build.gradle groovy script.

But if the document is written in this form:

dependencies {
    implementation(platform("com.linecorp.armeria:armeria-bom:1.14.1"))

    ...
    implementation("com.linecorp.armeria:armeria-retrofit2")
}

It's also compatible with build.gradle.kts(kotlin) script.
Recently, a lot of users are starting to use kotlin scripting.

I suggest to use this form(or display "Gradle", "Gradle(Kotlin)", "Maven" tabs at here)
image

@ikhoon ikhoon added this to the 1.15.0 milestone Feb 23, 2022
@ikhoon
Copy link
Contributor

ikhoon commented Feb 23, 2022

Nice suggestion! It should be helpful to add Gradle(Kotlin) tab to RequiredDependencies component.

<AntdTabs.TabPane tab="Gradle" key="gradle">
<CodeBlock language="groovy" filename="build.gradle">
{gradleDependency(props)}
</CodeBlock>
</AntdTabs.TabPane>

Are you interested in sending a PR? 😄

@clatisus
Copy link
Contributor

clatisus commented Mar 31, 2022

Hi @ikhoon @tokuhirom, I've put up a PR (#4176) to address this issue, could you please help review it?

@ikhoon
Copy link
Contributor

ikhoon commented Mar 31, 2022

Great! I’m happy to review it.

ikhoon pushed a commit that referenced this issue Apr 11, 2022
Motivation:

More users are starting to use Kotlin scripting, add this tab can help them copy-paste codes

Modifications:

- Add Gradle(Kotlin) tab to RequiredDependencies component

Result:

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

Successfully merging a pull request may close this issue.

4 participants