AlexanderAshitkin commented on code in PR #40:
URL:
https://github.com/apache/maven-build-cache-extension/pull/40#discussion_r1125518090
##########
src/site/markdown/getting-started.md:
##########
@@ -17,58 +17,66 @@
## Getting Started
-To on-board incremental Maven you need to complete several steps:
+To onboard incremental Maven you need to complete several steps:
* Declare caching extension in your project (either in `pom.xml` or
`.mvn/extensions.xml`)
-* Add `maven-build-cache-config.xml` cache config in `.mvn/` (optional) to
customize default behavior
-* Validate build results and iteratively, adjust config to properly reflect
project specifics
+* Add `maven-build-cache-config.xml` cache config in `.mvn/` (optional) to
customize the default behavior
+* Validate build results and iteratively adjust config to reflect project
specifics properly
* Setup remote cache (optional)
-### Declaring build cache extension
+### Declaring build-cache extension
```xml
+
<extension>
<groupId>org.apache.maven.extensions</groupId>
<artifactId>maven-build-cache-extension</artifactId>
- <version>1.0.0-SNAPSHOT</version>
+ <version>1.0.0</version>
</extension>
```
-either in `pom.xml`'s `<project>/<build>/<extensions>` or in
`.mvn/extensions.xml`'s `<extensions>`
+either in `pom.xml`'s `<project>/<build>/<extensions>` or in
`.mvn/extensions.xml`'s `<extensions>`. Using core
+extension model (`.mvn/extensions.xml` file) is preferable as it allows better
access to maven APIs and could allow
+more sophisticated optimizations in the future.
-### Adding build cache config
+### Adding build-cache config
Copy template config
[`maven-build-cache-config.xml`](../resources/maven-build-cache-config.xml)
to [`.mvn/`](https://maven.apache.org/configure.html) directory of your
project.
-To get overall understanding of build cache machinery, it is recommended to
review the config and read comments. In typical
-scenario you need to:
+To understand the caching machinery, review the config and read the comments.
In a typical scenario, need to:
Review Comment:
Changed to `In a typical scenario, you need to`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
