From b09b1040647f1431a57931fcfcc084b86959f57c Mon Sep 17 00:00:00 2001 From: Andrea Peruffo Date: Thu, 25 Jan 2024 13:34:24 +0000 Subject: [PATCH] More standard docs (#9) --- .github/workflows/release.yml | 4 ++-- .gitignore | 1 + docs/modules/ROOT/assets/images/.keepme | 0 docs/modules/ROOT/examples/.keepme | 0 docs/modules/ROOT/pages/index.adoc | 2 ++ docs/modules/ROOT/templates/includes/attributes.adoc | 3 +++ docs/pom.xml | 5 +++++ 7 files changed, 13 insertions(+), 2 deletions(-) create mode 100644 docs/modules/ROOT/assets/images/.keepme create mode 100644 docs/modules/ROOT/examples/.keepme create mode 100644 docs/modules/ROOT/templates/includes/attributes.adoc diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 9851ed4..00ed5dd 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -55,8 +55,8 @@ jobs: - name: Update latest release version in docs run: | mvn -B -ntp -pl docs -am generate-resources -Denforcer.skip -Dformatter.skip -Dimpsort.skip - if ! git diff --quiet docs/modules/ROOT/pages/includes/attributes.adoc; then - git add docs/modules/ROOT/pages/includes/attributes.adoc + if ! git diff --quiet docs/modules/ROOT/templates/includes/attributes.adoc; then + git add docs/modules/ROOT/templates/includes/attributes.adoc git commit -m "Update the latest release version ${{steps.metadata.outputs.current-version}} in documentation" fi diff --git a/.gitignore b/.gitignore index c507849..83fe80e 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ target .idea +.vscode diff --git a/docs/modules/ROOT/assets/images/.keepme b/docs/modules/ROOT/assets/images/.keepme new file mode 100644 index 0000000..e69de29 diff --git a/docs/modules/ROOT/examples/.keepme b/docs/modules/ROOT/examples/.keepme new file mode 100644 index 0000000..e69de29 diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc index 903f370..2e2668e 100644 --- a/docs/modules/ROOT/pages/index.adoc +++ b/docs/modules/ROOT/pages/index.adoc @@ -1,6 +1,8 @@ = Quarkus - Kiota :extension-status: preview +include::./includes/attributes.adoc[] + Quarkus' extension for generation of fully typed, client side SDKs based on OpenAPI specification files. This extension is based on the https://learn.microsoft.com/en-gb/openapi/kiota/[Microsoft Kiota] generator. diff --git a/docs/modules/ROOT/templates/includes/attributes.adoc b/docs/modules/ROOT/templates/includes/attributes.adoc new file mode 100644 index 0000000..e1a2881 --- /dev/null +++ b/docs/modules/ROOT/templates/includes/attributes.adoc @@ -0,0 +1,3 @@ +:project-version: ${release.current-version} + +:examples-dir: ./../examples/ \ No newline at end of file diff --git a/docs/pom.xml b/docs/pom.xml index ef45e7b..8984688 100644 --- a/docs/pom.xml +++ b/docs/pom.xml @@ -53,6 +53,11 @@ quarkus-kiota.adoc false + + ${project.basedir}/templates/includes + attributes.adoc + true +