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

Research for Dokka Gradle Plugin DSL 2.0 #3424

Closed
whyoleg opened this issue Dec 19, 2023 · 1 comment
Closed

Research for Dokka Gradle Plugin DSL 2.0 #3424

whyoleg opened this issue Dec 19, 2023 · 1 comment
Assignees
Labels
enhancement An issue for a feature or an overall improvement runner: Gradle plugin An issue/PR related to Dokka's Gradle plugin
Milestone

Comments

@whyoleg
Copy link
Collaborator

whyoleg commented Dec 19, 2023

Part of #3131

Goal is to prepare for redesigning the configuration DSL. During research we will need to gather all required information from multiple sources:

  • Dokka usage in various projects (big and small), f.e. gradle, aws-sdk, ktor, apollo-graphql, okio, okhttp, spring, android/androidx (?), etc:
    • think of how these projects are going to migrate to the new DSL / plugin, maybe we can add some deprecated configurations/tasks from the old plugin that will point to the new replacements
    • different formats usages
    • how it's configured
    • usage of specific features (collectors, multi-module, etc)
    • what doesn't work (and which hacks applied to fix)
  • dokkatoo - provides it's own Gradle configuration layer over Dokka engine (both code and current opened issues)
  • kotlinx-kover - have similar ideas (different formats, aggregation, etc)
  • KGP/AGP - mature Gradle plugins with which Dokka users are very familiar
  • Gradle docs on idiomatic configuration/DSL
  • configuration cache and project isolation requirements
  • internal UX researches and user interviews
  • internal list of problems and wishes
  • existing issues in Dokka with the configuration and gradle plugin tags
  • any other sources which will be found interesting during review (will be added to the list afterwards)
  • can spend some time on prototyping

Feel free to post any additional useful source in the comments!

@whyoleg whyoleg added enhancement An issue for a feature or an overall improvement runner: Gradle plugin An issue/PR related to Dokka's Gradle plugin labels Dec 19, 2023
@whyoleg whyoleg self-assigned this Dec 19, 2023
@IgnatBeresnev IgnatBeresnev added this to the Dokka 2.0.0 milestone Dec 20, 2023
@IgnatBeresnev
Copy link
Member

The research was conducted, the next steps are internal and external review. It will be published once the document is finalized

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement An issue for a feature or an overall improvement runner: Gradle plugin An issue/PR related to Dokka's Gradle plugin
Projects
None yet
Development

No branches or pull requests

2 participants