From c21d02c58c04e7fad4c7741c3b2a31e0986b638f Mon Sep 17 00:00:00 2001 From: Olivier Lamy Date: Mon, 16 Jun 2025 21:53:55 +1000 Subject: [PATCH 1/2] Simplify documentation links, home page as a simple getting started Signed-off-by: Olivier Lamy --- src/site/markdown/{index.md => concepts.md} | 9 --------- .../markdown/{getting-started.md.vm => index.md.vm} | 10 ++++++++++ src/site/site.xml | 8 ++++---- 3 files changed, 14 insertions(+), 13 deletions(-) rename src/site/markdown/{index.md => concepts.md} (94%) rename src/site/markdown/{getting-started.md.vm => index.md.vm} (89%) diff --git a/src/site/markdown/index.md b/src/site/markdown/concepts.md similarity index 94% rename from src/site/markdown/index.md rename to src/site/markdown/concepts.md index 89f3a09d..948d434f 100644 --- a/src/site/markdown/index.md +++ b/src/site/markdown/concepts.md @@ -123,12 +123,3 @@ builds instead. Such a scheme allows cache correctness validation by reconciling the outcomes of cached builds against the reference builds. -## See also - -* [Getting started](getting-started.html) - getting starting with cache and usage manual -* [Usage](usage.html) - shared cache setup procedure -* [Remote cache setup](remote-cache.html) - shared cache setup procedure -* [How-To](how-to.html) - cookbook for typical scenarios -* [Performance](performance.html) - performance tuning -* [Cache Parameters](parameters.html) - description of supported parameters -* [Sample config file](maven-build-cache-config.xml) diff --git a/src/site/markdown/getting-started.md.vm b/src/site/markdown/index.md.vm similarity index 89% rename from src/site/markdown/getting-started.md.vm rename to src/site/markdown/index.md.vm index 8e7d3df6..6cb04e59 100644 --- a/src/site/markdown/getting-started.md.vm +++ b/src/site/markdown/index.md.vm @@ -82,3 +82,13 @@ supporting get/put operations. Working examples: * [Nginx OSS](http://nginx.org/en/) with fs module See [Remote cache setup](remote-cache.html) for a detailed description of the remote cache setup + +## See also + +* [Usage](usage.html) - shared cache setup procedure +* [Remote cache setup](remote-cache.html) - shared cache setup procedure +* [How-To](how-to.html) - cookbook for typical scenarios +* [Performance](performance.html) - performance tuning +* [Cache Parameters](parameters.html) - description of supported parameters +* [Sample config file](maven-build-cache-config.xml) +* [Concepts](concepts.html) - getting starting with cache and usage manual diff --git a/src/site/site.xml b/src/site/site.xml index 52ad71cf..7edbd7b1 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -31,22 +31,22 @@ under the License. - - - + - + + + From 04d4808732c7c4f27b311999bd1591137588255f Mon Sep 17 00:00:00 2001 From: Olivier Lamy Date: Tue, 17 Jun 2025 20:17:07 +1000 Subject: [PATCH 2/2] is there any unnormal usage? Signed-off-by: Olivier Lamy --- src/site/markdown/usage.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/site/markdown/usage.md b/src/site/markdown/usage.md index 92ef3415..505dc460 100644 --- a/src/site/markdown/usage.md +++ b/src/site/markdown/usage.md @@ -15,7 +15,7 @@ limitations under the License. --> -## Normal usage +## Usage Once the extension is activated, the cache automatically kicks in on every `package` or higher phase.