Skip to content

Commit 4adf720

Browse files
committed
[HBX] Add links to documentation
1 parent 01927c2 commit 4adf720

File tree

4 files changed

+26
-2
lines changed

4 files changed

+26
-2
lines changed

_config/site.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -417,6 +417,10 @@ projects:
417417
- name: About
418418
href: '/tools/'
419419
css_class: 'home'
420+
- name: Documentation
421+
href: '/tools/documentation/'
422+
css_class: 'folder open'
423+
documentation_submenu: false
420424
- name: Contribute
421425
href: '/community/contribute/'
422426
css_class: 'users'

community/index.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Best to first check the documentation. Yes it sounds boring, but knowing a tool
2121
<a class="ui label" href="/search/documentation/"><i class="icon book"></i>Search</a>
2222
<a class="ui label" href="/validator/documentation/"><i class="icon book"></i>Validator</a>
2323
<a class="ui label" href="/reactive/documentation/"><i class="icon book"></i>Reactive</a>
24-
<a class="ui label" href="http://tools.jboss.org/documentation/"><i class="icon book"></i>Tools</a>
24+
<a class="ui label" href="/tools/documentation/"><i class="icon book"></i>Tools</a>
2525
</div>
2626
+++
2727

tools/documentation/index.adoc

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
= Documentation
2+
:awestruct-layout: project-standard
3+
:awestruct-project: tools
4+
:page-interpolate: true
5+
:docs_base_url: https://github.com/hibernate/hibernate-tools/blob/main/
6+
7+
link:{docs_base_url}/README.md[Main README]::
8+
Global overview and list of tools.
9+
link:{docs_base_url}/maven/README.md[`hibernate-tools-maven` reference]::
10+
Reference documentation for the Maven plugin of Hibernate Tools.
11+
link:{docs_base_url}/maven/docs/5-minute-tutorial.md[`hibernate-tools-maven` tutorial]::
12+
Five-minute tutorial for the Maven plugin of Hibernate Tools.
13+
link:{docs_base_url}/gradle/README.md[`hibernate-tools-gradle` reference]::
14+
Reference documentation for the Gradle plugin of Hibernate Tools.
15+
link:{docs_base_url}/gradle/docs/5-minute-tutorial.md[`hibernate-tools-gradle` tutorial]::
16+
Five-minute tutorial for the Gradle plugin of Hibernate Tools.
17+
link:{docs_base_url}/ant/docs/reference-guide.md[`hibernate-tools-ant` reference]::
18+
Reference documentation for the Ant tasks of Hibernate Tools.
19+
link:{docs_base_url}/ant/docs/5-minute-tutorial.md[`hibernate-tools-ant` tutorial]::
20+
Five-minute tutorial for the Ant tasks of Hibernate Tools.

tools/index.html.haml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ project: tools
114114
me@machine foo %
115115
-----
116116

117-
Of course all these defaults can be overridden and tuned. Please consult the documentation for more information.
117+
Of course all these defaults can be overridden and tuned. Refer to the link:./documentation[documentation] for more information.
118118

119119
.feature-block
120120
:asciidoc

0 commit comments

Comments
 (0)