Enhance How to use it documentation #27
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Gian de Manincor <gianmanincor@gmail.com>
GianDeManincor
force-pushed
the
adding-commit-and-rollback-documentation
branch
from
0db73b1
to
73d5581
Compare
Signed-off-by: Gian de Manincor <gianmanincor@gmail.com>
dearrudam
approved these changes
Jan 26, 2024
dearrudam
requested changes
Jan 26, 2024
dearrudam
reviewed
Jan 26, 2024
| @@ -14,6 +14,8 @@ Facilitate manipulation such as managing POM dependencies through CLI (command l | |||
|
|
|||
| == How to use it | |||
|
|
|||
| ==== Add a dependency | |||
There was a problem hiding this comment.
Suggested change
| ==== Add a dependency | |
| === Add a dependency |
dearrudam
reviewed
Jan 26, 2024
| @@ -41,6 +43,37 @@ Then you'll be able to perform the plugin by its prefix: | |||
| mvn pom-editor:add-dep -Dgav='org.junit.jupiter:junit-jupiter:5.9.2' -Dscope=test | |||
| ---- | |||
|
|
|||
| ==== Confirm the changes | |||
There was a problem hiding this comment.
Suggested change
| ==== Confirm the changes | |
| === Confirm the changes |
dearrudam
reviewed
Jan 26, 2024
| [source,sh] | ||
| $ mvn pom-editor:commit | ||
|
|
||
| ==== Revert the changes |
There was a problem hiding this comment.
Suggested change
| ==== Revert the changes | |
| === Revert the changes |
dearrudam
reviewed
Jan 26, 2024
| @@ -14,6 +14,8 @@ Facilitate manipulation such as managing POM dependencies through CLI (command l | |||
|
|
|||
| == How to use it | |||
|
|
|||
There was a problem hiding this comment.
Suggested change
| [TIP] | |
| =============================== | |
| In order to make easier the plugin utilization we can register the groupId into the `settings.xml` like the snipped code below: | |
| [source,xml] | |
| ---- | |
| <settings > | |
| <!-- snipped --> | |
| <pluginGroups> | |
| <pluginGroup>br.org.soujava</pluginGroup> | |
| </pluginGroups> | |
| <!-- snipped --> | |
| </settings> | |
| ---- | |
| With that, we will be able to perform the plugin by using its prefix. | |
| So, instead of to perform the plugin by the following command: | |
| [source, sh] | |
| ---- | |
| mvn br.org.soujava:pom-editor-maven-plugin:<GOAL> | |
| ---- | |
| We may perform it just providing its prefix like below: | |
| [source, sh] | |
| ---- | |
| mvn pom-editor:<GOAL> | |
| ---- | |
| In the documentation, we'll assume that you have done this configuration. | |
| =============================== | |
dearrudam
previously requested changes
Jan 26, 2024
dearrudam
approved these changes
Jan 27, 2024
|
@GianDeManincor, thanks for the contribution! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I am improving and organizing the How to use it documentation.
My idea was to create a subtitles for each topic: