Skip to content

Simplify documentation links, home page as a simple getting started #347

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

Merged
merged 2 commits into from
Jun 17, 2025
Merged

Simplify documentation links, home page as a simple getting started #347

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c21d02c
Simplify documentation links, home page as a simple getting started
olamy Jun 16, 2025
04d4808
is there any unnormal usage?
olamy Jun 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 0 additions & 9 deletions src/site/markdown/index.md → src/site/markdown/concepts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
10 changes: 10 additions & 0 deletions src/site/markdown/getting-started.md.vm → src/site/markdown/index.md.vm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion src/site/markdown/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
8 changes: 4 additions & 4 deletions src/site/site.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,22 +31,22 @@ under the License.
</breadcrumbs>

<menu name="Overview">
<item name="Introduction" href="index.html"/>
<item name="JavaDocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<item name="Getting Started" href="index.html"/>
</menu>

<menu name="Documentation">
<item name="Getting Started" href="getting-started.html"/>
<item name="Usage" href="usage.html"/>
<item name="Remote Cache Setup" href="remote-cache.html"/>
<item name="Howto" href="how-to.html"/>
<item name="Performance" href="performance.html"/>
<item name="Cache Parameters" href="parameters.html"/>
<item name="Concepts" href="concepts.html"/>
</menu>

<menu name="Reference">
<item name="maven-build-cache-config.xml" href="build-cache-config.html"/>
<item name="JavaDocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
</menu>

<menu name="Cache Internals">
Expand Down