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

DGP v2 migration guide #3813

Merged
merged 9 commits into from
Sep 30, 2024
Merged

DGP v2 migration guide #3813

merged 9 commits into from
Sep 30, 2024

Conversation

AlejandraPedroza
Copy link
Contributor

@AlejandraPedroza AlejandraPedroza commented Sep 19, 2024

This PR contains a guide to migrate to Dokka Gradle Plugin v2

KT-70619/

@adam-enko adam-enko added runner: Gradle plugin An issue/PR related to Dokka's Gradle plugin documentation An issue/PR related to Dokka's external or internal documentation labels Sep 19, 2024
@adam-enko adam-enko added this to the Dokka 2.0.0 milestone Sep 19, 2024
@Tapchicoma Tapchicoma removed their request for review September 19, 2024 11:58
@Herudaio Herudaio self-requested a review September 19, 2024 14:27
docs/topics/dokkatoo-migration.md Outdated Show resolved Hide resolved
docs/topics/dokkatoo-migration.md Outdated Show resolved Hide resolved
docs/topics/dokkatoo-migration.md Outdated Show resolved Hide resolved
docs/topics/dokkatoo-migration.md Outdated Show resolved Hide resolved
docs/topics/dokkatoo-migration.md Outdated Show resolved Hide resolved
docs/topics/dokkatoo-migration.md Outdated Show resolved Hide resolved
docs/topics/dokkatoo-migration.md Outdated Show resolved Hide resolved
docs/topics/dokkatoo-migration.md Outdated Show resolved Hide resolved
docs/topics/dokkatoo-migration.md Outdated Show resolved Hide resolved
docs/topics/dokkatoo-migration.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@whyoleg whyoleg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!
But looks like I still have some small remarks :)

docs/topics/dokkatoo-migration.md Outdated Show resolved Hide resolved
docs/topics/dokkatoo-migration.md Outdated Show resolved Hide resolved
docs/topics/dokkatoo-migration.md Outdated Show resolved Hide resolved
docs/topics/dokkatoo-migration.md Outdated Show resolved Hide resolved
docs/topics/dokkatoo-migration.md Outdated Show resolved Hide resolved
docs/topics/dokkatoo-migration.md Outdated Show resolved Hide resolved
docs/topics/dokkatoo-migration.md Outdated Show resolved Hide resolved
docs/topics/dokkatoo-migration.md Outdated Show resolved Hide resolved
docs/topics/dokkatoo-migration.md Outdated Show resolved Hide resolved
Copy link
Member

@adam-enko adam-enko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work!

I agree with the remaining comments, so they should be resolved.

I'm keen to get this merged ASAP, so we can keep refining it (which will be easier when I can more easily see the rendered output!), and get early feedback.

@atyrin
Copy link
Contributor

atyrin commented Sep 23, 2024

I think we missing a migration tip for a popular custom option from Dokka settings:

tasks.dokkaHtml{
    dokkaSourceSets {
        configureEach {
            outputDirectory.set(layout.buildDirectory.dir("dokkaDir"))
        }
    }
}

As I understand, the new version is:

dokka {
    dokkaPublicationDirectory.set(layout.buildDirectory.dir("dokkaDir"))
}

Copy link
Collaborator

@whyoleg whyoleg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Thank you for resolving all of the comments!

@zamulla zamulla self-assigned this Sep 26, 2024
Copy link

@zamulla zamulla left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Huge work! Most of my suggestions are surface-level, but I did offer some thoughts on clearer communication here and there.

docs/topics/dokka-migration.md Outdated Show resolved Hide resolved
docs/topics/dokka-migration.md Outdated Show resolved Hide resolved
docs/topics/dokka-migration.md Show resolved Hide resolved
docs/topics/dokka-migration.md Outdated Show resolved Hide resolved
docs/topics/dokka-migration.md Outdated Show resolved Hide resolved
docs/topics/dokka-migration.md Outdated Show resolved Hide resolved
docs/topics/dokka-migration.md Show resolved Hide resolved
docs/topics/dokka-migration.md Outdated Show resolved Hide resolved
docs/topics/dokka-migration.md Outdated Show resolved Hide resolved
docs/topics/dokka-migration.md Outdated Show resolved Hide resolved
Copy link

@zamulla zamulla left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One more comment for clarification, otherwise, no notes 💪

docs/topics/dokka-migration.md Show resolved Hide resolved
@AlejandraPedroza AlejandraPedroza merged commit 745d889 into master Sep 30, 2024
14 checks passed
@adam-enko adam-enko deleted the dokkatoo-migration-guide branch September 30, 2024 13:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation An issue/PR related to Dokka's external or internal documentation runner: Gradle plugin An issue/PR related to Dokka's Gradle plugin
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants