Skip to content

Commit

Permalink
Fix docs for release (quarkiverse#759)
Browse files Browse the repository at this point in the history
  • Loading branch information
gastaldi authored and FelixScherzinger committed Sep 18, 2024
1 parent 97a708a commit 86859d4
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 2 deletions.
2 changes: 2 additions & 0 deletions docs/modules/ROOT/pages/client.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
= Quarkus - OpenAPI Generator - Client

include::./includes/attributes.adoc[]
:extension-status: preview

This extension is for REST code generation for client side only. If you're looking for code generation for the server side, please take a look at the xref:server.adoc[Quarkus OpenAPI Generator Server Extension].
Expand Down
3 changes: 3 additions & 0 deletions docs/modules/ROOT/pages/includes/attributes.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
:project-version: 2.4.5

:examples-dir: ./../examples/
4 changes: 3 additions & 1 deletion docs/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
= Quarkus - OpenAPI Generator

include::./includes/attributes.adoc[]
:extension-status: preview

This a multipurpose Quarkus' extension for generation of https://quarkus.io/guides/rest-client[Rest Clients] and xref:server.adoc[Server stubs] based on OpenAPI specification files.
Expand All @@ -14,4 +16,4 @@ WARNING: Check versions 1.x.x if you're still using Quarkus 2. But be aware that
This extension is based on the https://openapi-generator.tech/[OpenAPI Generator Tool]. Please consider donation to help them maintain the
project: https://opencollective.com/openapi_generator/donate

include::includes/want-to-contribute.adoc[]
include::includes/want-to-contribute.adoc[]
5 changes: 4 additions & 1 deletion docs/modules/ROOT/pages/server.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
= Quarkus - OpenAPI Generator - Server

include::./includes/attributes.adoc[]

:extension-status: preview

Quarkus' extension for generation of server Stubs based on OpenAPI specification files.
Expand All @@ -12,4 +15,4 @@ include::includes/want-to-contribute.adoc[]
[[getting-started]]
== Getting Started

include::./includes/server-getting-started.adoc[leveloffset=+1, opts=optional]
include::./includes/server-getting-started.adoc[leveloffset=+1, opts=optional]
5 changes: 5 additions & 0 deletions docs/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,11 @@
<include>quarkus-openapi-generator.adoc</include>
<filtering>false</filtering>
</resource>
<resource>
<directory>${project.basedir}/templates/includes</directory>
<include>attributes.adoc</include>
<filtering>true</filtering>
</resource>
</resources>
</configuration>
</execution>
Expand Down
3 changes: 3 additions & 0 deletions docs/templates/includes/attributes.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
:project-version: ${release.current-version}

:examples-dir: ./../examples/

0 comments on commit 86859d4

Please sign in to comment.