Document how to use the Gradle plugin with the Kotlin DSL
Open
Nobody has claimed this yet.
- Dominant language
- Kotlin
- Stars
- 4.4k
- Forks
- 627
- Avg merge
- 3d 15m
- Merged PRs (30d)
- 20
Description
I had troubles setting up the plugin with the Kotlin DSL
I wanted to contribute the setup I had found to work, but I couuldn't edit the mkdocs website, so here it is:
settings.gradle.kts
pluginManagement {
repositories {
gradlePluginPortal()
mavenCentral()
}
resolutionStrategy {
eachPlugin {
if (requested.id.id == "com.squareup.wire") {
useModule("com.squareup.wire:wire-gradle-plugin:<version>")
}
}
}
}
build.gradle.kts
plugins {
id("com.squareup.wire")
}
wire {
kotlin {
}
}
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the MkDocs website's existing Gradle plugin documentation and compare its setup guidance with the supplied settings.gradle.kts and build.gradle.kts examples. Document the Kotlin DSL configuration and consider the work complete when a reader can follow the examples to configure the Wire plugin.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kotlin
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100