From 01017cb020974fce0d34275a751fddb8417e411d Mon Sep 17 00:00:00 2001 From: Chris Bono Date: Sat, 13 Aug 2022 00:25:53 -0500 Subject: [PATCH] [DOCS] Support for new Wiki (#63) * Links to wiki from CONTRIBUTING.adoc * Adds idea code style (it is mentioned in wiki) * Adds asciidocs target in build (it is mentioned in wiki) --- CONTRIBUTING.adoc | 5 +- README.adoc | 8 +- idea/codeStyleConfig.xml | 128 ++++++++++++++++++++++++++++++++ spring-pulsar-docs/build.gradle | 8 +- 4 files changed, 140 insertions(+), 9 deletions(-) create mode 100644 idea/codeStyleConfig.xml diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index 1e4038b6..681b311c 100755 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc @@ -1,5 +1,7 @@ = Contributing to Spring Pulsar +:github: https://github.com/spring-projects-experimental/spring-pulsar + Spring Pulsar is released under the Apache 2.0 license. If you would like to contribute something, or want to hack on the code this document should help you get started. @@ -56,5 +58,4 @@ added after the original pull request but before a merge. == Working with the Code -**#TODO#** -For information on editing, building, and testing the code, see the https://github.com/spring-projects/spring-pulsar/wiki/Working-with-the-Code[Working with the Code] page on the project wiki. +For information on editing, building, and testing the code, see the link:${github}/wiki/Working-with-the-Code[Working with the Code] page on the project wiki. diff --git a/README.adoc b/README.adoc index 5a67375f..b6a62e43 100644 --- a/README.adoc +++ b/README.adoc @@ -40,18 +40,18 @@ We like to know the Spring Pulsar version, operating system, and JVM version you You don't need to build from source to use Spring Pulsar (binaries in https://repo.spring.io[repo.spring.io]), but if you want to try out the latest and greatest, Spring Pulsar can be built and published to your local Maven cache using the https://docs.gradle.org/current/userguide/gradle_wrapper.html[Gradle wrapper]. You also need JDK 17. -[indent=0] +[source,shell] ---- - $ ./gradlew publishToMavenLocal +./gradlew publishToMavenLocal ---- This will build all of the jars and documentation and publish them to your local Maven cache. It won't run any of the tests. If you want to build everything, use the `build` task: -[indent=0] +[source,shell] ---- - $ ./gradlew build +./gradlew build ---- diff --git a/idea/codeStyleConfig.xml b/idea/codeStyleConfig.xml new file mode 100644 index 00000000..cd1c76fe --- /dev/null +++ b/idea/codeStyleConfig.xml @@ -0,0 +1,128 @@ + + + + diff --git a/spring-pulsar-docs/build.gradle b/spring-pulsar-docs/build.gradle index 8c06cadf..fcefb4ad 100644 --- a/spring-pulsar-docs/build.gradle +++ b/spring-pulsar-docs/build.gradle @@ -107,10 +107,12 @@ syncDocumentationSourceForAsciidoctorPdf { } } +task asciidocs { + dependsOn asciidoctor, asciidoctorMultipage, asciidoctorPdf +} + task docsZip(type: Zip) { - dependsOn asciidoctor, - asciidoctorMultipage, - asciidoctorPdf + dependsOn asciidocs group = 'Distribution' archiveClassifier = 'docs' description = "Builds docs archive containing api and reference for deployment at static.spring.io/spring-pulsar/docs."