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.

Sign up for GitHub

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

Jump to bottom

update: DGPV2 migration guide #4025

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

update: DGPV2 migration guide #4025

wants to merge 7 commits into from

Conversation

AlejandraPedroza
Copy link
Contributor

@AlejandraPedroza AlejandraPedroza commented Feb 10, 2025 •
edited
Loading

This PR contains updates for the DGP V2 Migration guide.

The additions to the Migration guide are:

  • Add context for cases when people are not using convention plugins in their multi-module build.
  • Clarify a bit earlier that the formats you obtain now require adding more dependencies (if you want javadoc)
  • externalDocumentationLinks has changed API and it's missing in migration guide
  • Document Output directory for additional files
  • Document how to configure Dokka Plugins
  • Document how to configure custom Dokka Plugins
  • Document sourceLink
  • Highlight what are migration helpers in migration guide
  • Document the change of directory in DGPv2

Additionally, there are some fixes in the code format and indentation. Plus, the content within "Adjust configuration options" is now broken into single subsections instead of bullet points.

KT-72053 [Dokka] DGP v2 migration guide feedback

@AlejandraPedroza AlejandraPedroza force-pushed the DGPV2-update-migration-guide branch from f4b0526 to fb10fbd Compare February 10, 2025 14:11
@AlejandraPedroza AlejandraPedroza changed the title This PR contains updates for the DGP V2 Migration guide. update: DGPV2 migration guide Feb 11, 2025
atyrin
atyrin reviewed Feb 12, 2025
View reviewed changes
whyoleg
whyoleg approved these changes Feb 13, 2025
View reviewed changes
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!
There are some small comments from me, but overall looks good!

@AlejandraPedroza AlejandraPedroza force-pushed the DGPV2-update-migration-guide branch from ed43b97 to dd02f2e Compare February 25, 2025 14:44
whyoleg
whyoleg reviewed Feb 26, 2025
View reviewed changes
@whyoleg whyoleg mentioned this pull request Feb 26, 2025
Closed
whyoleg
whyoleg reviewed Feb 27, 2025
View reviewed changes
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.

found some more minor nitpicks :)

@adam-enko adam-enko mentioned this pull request Mar 4, 2025
Closed
@AlejandraPedroza AlejandraPedroza force-pushed the DGPV2-update-migration-guide branch from 09d4e21 to 7a96118 Compare March 4, 2025 16:43
@daniCsorbaJB daniCsorbaJB self-assigned this Mar 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@whyoleg whyoleg whyoleg approved these changes

@atyrin atyrin atyrin approved these changes

@adam-enko adam-enko adam-enko approved these changes

Assignees

@daniCsorbaJB daniCsorbaJB

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@AlejandraPedroza @atyrin @whyoleg @adam-enko @daniCsorbaJB