Skip to content

Fix asciidoctor-maven-plugin's phase #181

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

Closed
wants to merge 2 commits into from

Conversation

making
Copy link
Member

@making making commented Dec 17, 2015

The document (6) explains prepare-package should be used, but the example is package.

Actually, I had a trouble copying and pasting according to this doc.

@wilkinsona wilkinsona modified the milestone: 1.0.2.RELEASE Dec 17, 2015
@wilkinsona
Copy link
Member

Sorry that you found this confusing. The need to use prepare-package if you want to include the documentation in the jar file is mentioned in the call out referenced by (6):

(6) If you want to package the documentation in your project’s jar you should use the prepare-package phase.

It's also mentioned again in the Packaging the documentation section:

First, configure the Asciidoctor plugin so that it runs in the prepare-package phase, as described above

If you have suggestions for how to make this clearer, I'd definitely like to hear them. However, I can't merge this change in its current form as it'll mean that the sections mentioned above (among others) no longer make sense.

@wilkinsona wilkinsona added the status: waiting-for-feedback Feedback is required before progress can be made label Dec 17, 2015
to avoid confusion confusing.
@making
Copy link
Member Author

making commented Dec 18, 2015

Thank you for your comment.
I found I had misunderstood.

Updated PR to explain the phase explicitly.
How do you think?

@wilkinsona
Copy link
Member

Having thought about this some more, I think it might be best to update the documentation to always use prepare-package for the phase. It'll be a lot simpler as it'll mean one set of instructions that'll work for those who want to embed the documentation in the jar and those that don't.

@wilkinsona
Copy link
Member

Thanks for the PR. As discussed above, I've decided to address the problem by recommending that the Asciidoctor plugin is always bound to the prepare-package phase. See #218 for that change.

@wilkinsona wilkinsona closed this Apr 4, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants