diff --git a/docs/pom.xml b/docs/pom.xml index f8f06c35e0fb2..b59b430c1764c 100644 --- a/docs/pom.xml +++ b/docs/pom.xml @@ -61,7 +61,6 @@ io.quarkus quarkus-devtools-registry-client - ${project.version} io.quarkus @@ -77,7 +76,6 @@ org.asciidoctor asciidoctorj - ${asciidoctorj.version} @@ -2804,6 +2802,37 @@ + + maven-resources-plugin + + + copy-resources + process-resources + + copy-resources + + + ${project.basedir}/target/asciidoc/sources + + + src/main/asciidoc + false + + **/attributes.adoc + + + + src/main/asciidoc + true + + **/attributes.adoc + + + + + + + org.codehaus.mojo exec-maven-plugin @@ -2876,7 +2905,7 @@ ${code-example-dir} ${project.basedir}/.. - ${project.basedir}/src/main/asciidoc + ${project.basedir}/target/asciidoc/sources ${env.MAVEN_CMD_LINE_ARGS} @@ -2893,7 +2922,7 @@ ${skipDocs} io.quarkus.docs.generation.YamlMetadataGenerator - ${project.basedir}/src/main/asciidoc + ${project.basedir}/target/asciidoc/sources ${project.basedir}/target @@ -2906,7 +2935,6 @@ org.asciidoctor asciidoctor-maven-plugin - ${asciidoctor-maven-plugin.version} ${skipDocs} true @@ -2915,7 +2943,7 @@ WARN - src/main/asciidoc + target/asciidoc/sources true ${project.basedir}/../target/asciidoc/generated @@ -2929,81 +2957,11 @@ true true - - ${project.version} - ${version.surefire.plugin} - ${graal-sdk.version-for-documentation} - ${graal-sdk.version-for-documentation}-java11 - ${mandrel.version-for-documentation} - ${mandrel.version-for-documentation}-java11 - ${rest-assured.version} - ${proposed-maven-version} - ${gradle-wrapper.version} - ${elasticsearch.image} - ${logstash.image} - ${kibana.image} - ${keycloak.docker.image} - - ${jandex.version} - ${jandex-gradle-plugin.version} - ${kotlin.version} - - ${grpc.version} - ${protoc.version} - ${elasticsearch-server.version} - ${gcf-invoker.version} - - - ${quarkus-home-url} - - https://github.com/quarkusio - - - - ${quarkus-home-url}/getting-started - ${quarkus-home-url}/documentation/extension-authors-guide - ${quarkus-home-url}/live-coding - - - https://quarkusio.zulipchat.com/# - quarkus-dev+subscribe@googlegroups.com - https://groups.google.com/d/forum/quarkus-dev - - - - ${quarkus-base-url} - - ${quarkus-base-url}.git - - ${quarkus-base-url}/archive/main.zip - - ${quarkus-base-url}/blob/main - - ${quarkus-base-url}/tree/main - - ${quarkus-base-url}/issues - https://github.com/quarkusio/quarkus-images/tree - - - - ${quickstarts-base-url} - - ${quickstarts-base-url}.git - - ${quickstarts-base-url}/archive/main.zip - - ${quickstarts-base-url}/blob/main - - ${quickstarts-base-url}/tree/main - - - https://quarkiverse.github.io/quarkiverse-docs/quarkus-amazon-services/dev/index.html - https://quarkiverse.github.io/quarkiverse-docs/quarkus-config-extensions/dev/consul.html - https://quarkiverse.github.io/quarkiverse-docs/quarkus-hibernate-search-extras/dev/index.html - https://quarkiverse.github.io/quarkiverse-docs/quarkus-neo4j/dev/index.html - https://quarkiverse.github.io/quarkiverse-docs/quarkus-vault/dev/index.html - https://quarkiverse.github.io/quarkiverse-docs/quarkus-vault/dev/vault-datasource.html - https://quarkiverse.github.io/quarkiverse-docs/quarkus-micrometer-registry/dev/ + diff --git a/docs/src/main/asciidoc/attributes-local.adoc b/docs/src/main/asciidoc/attributes-local.adoc new file mode 100644 index 0000000000000..01c742337cd96 --- /dev/null +++ b/docs/src/main/asciidoc/attributes-local.adoc @@ -0,0 +1,13 @@ +// for rendering the final website the attributes are set in the appropriate +// location based on source versions in https://github.com/quarkusio/quarkusio.github.io/ +// they are duplicated here to ease the preview when editing in the IDE +:idprefix: +:idseparator: - +:icons: font +:code-examples: ../../../../target/asciidoc/examples +:doc-guides: ./ +:doc-examples: ./_examples +:generated-dir: ../../../../target/asciidoc/generated +:imagesdir: ./images +:includes: ./includes +:toc: preamble diff --git a/docs/src/main/asciidoc/attributes.adoc b/docs/src/main/asciidoc/attributes.adoc index 01c742337cd96..c45a43ecef4ff 100644 --- a/docs/src/main/asciidoc/attributes.adoc +++ b/docs/src/main/asciidoc/attributes.adoc @@ -1,13 +1,52 @@ -// for rendering the final website the attributes are set in the appropriate -// location based on source versions in https://github.com/quarkusio/quarkusio.github.io/ -// they are duplicated here to ease the preview when editing in the IDE -:idprefix: -:idseparator: - -:icons: font -:code-examples: ../../../../target/asciidoc/examples -:doc-guides: ./ -:doc-examples: ./_examples -:generated-dir: ../../../../target/asciidoc/generated -:imagesdir: ./images -:includes: ./includes -:toc: preamble +:project-name: Quarkus +:quarkus-version: ${project.version} + +:maven-version: ${proposed-maven-version} +:graalvm-version: ${graal-sdk.version-for-documentation} +:graalvm-flavor: ${graal-sdk.version-for-documentation}-java11 +:mandrel-version: ${mandrel.version-for-documentation} +:mandrel-flavor: ${mandrel.version-for-documentation}-java11 +:surefire-version: ${version.surefire.plugin} +:gradle-version: ${gradle-wrapper.version} +:elasticsearch-version: ${elasticsearch-server.version} +:elasticsearch-image: ${elasticsearch.image} +:logstash-image: ${logstash.image} +:kibana-image: ${kibana.image} +:keycloak-docker-image: ${keycloak.docker.image} +:jandex-version: ${jandex.version} +:jandex-gradle-plugin.version: ${jandex-gradle-plugin.version} +:kotlin-version: ${kotlin.version} +:grpc-version: ${grpc.version} +:protoc-version: ${protoc.version} +:gcf-invoker-version: ${gcf-invoker.version} + +:quarkus-home-url: ${quarkus-home-url} +:quarkus-org-url: https://github.com/quarkusio +:quarkus-site-getting-started: /get-started +:quarkus-writing-extensions-guide: /guides/writing-extensions +:quarkus-site-publications: /publications +:quarkus-base-url: ${quarkus-base-url} +:quarkus-clone-url: ${quarkus-base-url}.git +:quarkus-archive-url: ${quarkus-base-url}/archive/main.zip +:quarkus-blob-url: ${quarkus-base-url}/blob/main +:quarkus-tree-url: ${quarkus-base-url}/tree/main +:quarkus-issues-url: ${quarkus-base-url}/issues +:quarkus-images-url: https://github.com/quarkusio/quarkus-images/tree +:quarkus-chat-url: https://quarkusio.zulipchat.com +:quarkus-mailing-list-subscription-email: quarkus-dev+subscribe@googlegroups.com +:quarkus-mailing-list-index: https://groups.google.com/d/forum/quarkus-dev +:quickstarts-base-url: ${quickstarts-base-url} +:quickstarts-clone-url: ${quickstarts-base-url}.git +:quickstarts-archive-url: ${quickstarts-base-url}/archive/main.zip +:quickstarts-blob-url: ${quickstarts-base-url}/blob/main +:quickstarts-tree-url: ${quickstarts-base-url}/tree/main + +:amazon-services-guide: https://quarkiverse.github.io/quarkiverse-docs/quarkus-amazon-services/dev/index.html +:config-consul-guide: https://quarkiverse.github.io/quarkiverse-docs/quarkus-config-extensions/dev/consul.html +:hibernate-search-orm-elasticsearch-aws-guide: https://quarkiverse.github.io/quarkiverse-docs/quarkus-hibernate-search-extras/dev/index.html +:neo4j-guide: https://quarkiverse.github.io/quarkiverse-docs/quarkus-neo4j/dev/index.html +:vault-guide: https://quarkiverse.github.io/quarkiverse-docs/quarkus-vault/dev/index.html +:vault-datasource-guide: https://quarkiverse.github.io/quarkiverse-docs/quarkus-vault/dev/vault-datasource.html +:micrometer-registry-guide: https://quarkiverse.github.io/quarkiverse-docs/quarkus-micrometer-registry/dev/index.html + +include::./attributes-local.adoc[] \ No newline at end of file diff --git a/docs/src/main/asciidoc/doc-reference.adoc b/docs/src/main/asciidoc/doc-reference.adoc index 2a5178b9fc9a6..aaf84c2c2f83f 100644 --- a/docs/src/main/asciidoc/doc-reference.adoc +++ b/docs/src/main/asciidoc/doc-reference.adoc @@ -298,7 +298,6 @@ The complete list of externalized variables for use is given in the following ta |Property Name|Value|Description |\{quarkus-version}|{quarkus-version}|The current version of the project. |\{quarkus-home-url}|{quarkus-home-url}| The location of the project home page. -|\{quarkus-site-getting-started}|{quarkus-site-getting-started}| The location of the getting started page. |\{quarkus-org-url}|{quarkus-org-url}| The location of the project GitHub organization. |\{quarkus-base-url}|{quarkus-base-url}| Quarkus GitHub URL common base prefix. diff --git a/docs/sync-web-site.sh b/docs/sync-web-site.sh index 429ee82a40917..708399d683033 100755 --- a/docs/sync-web-site.sh +++ b/docs/sync-web-site.sh @@ -43,14 +43,14 @@ else TARGET_CONFIG=${TARGET_DIR}/_generated-config/${BRANCH} fi -echo "Copying from src/main/asciidoc/* to $TARGET_GUIDES" +echo "Copying from target/asciidoc/sources/* to $TARGET_GUIDES" rsync -vr --delete \ --exclude='**/*.html' \ --exclude='**/index.adoc' \ - --exclude='**/attributes.adoc' \ + --exclude='**/attributes-local.adoc' \ --exclude='**/guides.md' \ --exclude='**/_templates' \ - src/main/asciidoc/* \ + target/asciidoc/sources/* \ $TARGET_GUIDES echo "\nCopying from ../target/asciidoc/generated/ to $TARGET_CONFIG"