Repository: polygene-java Updated Branches: refs/heads/serialization-3.0 9dcb18ebb -> 98d8a8c3b
website: minor content changes Project: http://git-wip-us.apache.org/repos/asf/polygene-java/repo Commit: http://git-wip-us.apache.org/repos/asf/polygene-java/commit/fba4bdf6 Tree: http://git-wip-us.apache.org/repos/asf/polygene-java/tree/fba4bdf6 Diff: http://git-wip-us.apache.org/repos/asf/polygene-java/diff/fba4bdf6 Branch: refs/heads/serialization-3.0 Commit: fba4bdf68ba993d60c7317b5b06afe5111bd2bc1 Parents: d13c322 Author: Paul Merlin <[email protected]> Authored: Sun Feb 26 20:29:22 2017 +0100 Committer: Paul Merlin <[email protected]> Committed: Sun Feb 26 20:29:22 2017 +0100 ---------------------------------------------------------------------- .../src/docs/tutorials/howto-build-system.txt | 34 +++++++------------- .../src/docs/tutorials/howto-writing-docs.txt | 4 +-- manual/src/docs/website/home.txt | 3 +- 3 files changed, 14 insertions(+), 27 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/polygene-java/blob/fba4bdf6/manual/src/docs/tutorials/howto-build-system.txt ---------------------------------------------------------------------- diff --git a/manual/src/docs/tutorials/howto-build-system.txt b/manual/src/docs/tutorials/howto-build-system.txt index 0daa44f..0aa7b38 100644 --- a/manual/src/docs/tutorials/howto-build-system.txt +++ b/manual/src/docs/tutorials/howto-build-system.txt @@ -31,7 +31,7 @@ If instead you want to setup your project build system to depend on modules of t == Gradle == NOTE: All major Java IDEs have great Gradle support. -Visit the http://www.gradle.org/tooling[Gradle Tooling] page to learn how to import the Polygene⢠SDK build into your +Visit the https://www.gradle.org/resources[Gradle] website to learn how to import the Polygene⢠SDK build into your favorite IDE. Polygene⢠community migrated away from Maven after several years of frustration, especially around release management, @@ -39,65 +39,57 @@ versioning and cross-module dependency resolution issues, in Feb 2011. The tool of choice is now Gradle, and it doesn't require any installation, there are +gradlew+ and +gradlew.bat+ in the root folder of the Polygene⢠SDK that will bootstrap Gradle if not done so already. -If you are new to Gradle, you should keep the http://www.gradle.org/documentation[documentation] at hands. +If you are new to Gradle, you should keep the https://gradle.org/docs[documentation] at hands. Build System configuration is done through Gradle properties. This can be done in many ways, see -http://gradle.org/docs/current/userguide/tutorial_this_and_that.html#sec:gradle_properties_and_system_properties[Gradle properties and system properties]. +https://docs.gradle.org/current/userguide/build_environment.html#sec:gradle_properties_and_system_properties[Gradle properties and system properties]. == Main tasks == The Polygene⢠SDK project has tasks that work with the whole SDK. -downloadDependencies:: -+ +`./gradlew downloadDependencies`:: -- Resolve, download and cache all needed dependencies. Useful to go offline. -- -./gradlew:: -+ +`./gradlew`:: -- The default build, triggered when running gradle without any command line arguments, compiles the code and run the tests, but nothing else. A quick way to check that nothing broke. -- -./gradlew clean:: -+ +`./gradlew clean`:: -- Clean up of all build output and restore the code base to a fresh state. -- -./gradlew assemble:: -+ +`./gradlew assemble`:: -- Produces all the archives, javadocs, manuals and website content. Global output is generated into +distributions/build+. -- -./gradlew check:: -+ +`./gradlew check`:: -- Run the tests and other checks like checkstyle. Global reports are generated in +reports/build/reports+. -- -./gradlew build:: -+ +`./gradlew build`:: -- Equivalent to `./gradlew assemble check` -- -./gradlew checkDistributions:: -+ +`./gradlew checkDistributions`:: -- Run global checks against the assembled distributions. Can take a while. -- -install:: -+ +`./gradlew install`:: -- Is roughly the same as Maven's install goal. It produces the test reports, javadocs and installs all the Jars into the local disk repository, for consumption @@ -292,7 +284,5 @@ And here is how to deploy a signed release to the local filesystem: ./gradlew uploadArchives -Dversion=3.2.1 -PuploadRepository=file:///path/to/local/repository ----------- -See the http://www.gradle.org/docs/current/userguide/maven_plugin.html#wagonLibs[Gradle documentation] about +See the https://docs.gradle.org/current/userguide/maven_plugin.html#wagonLibs[Gradle documentation] about supported protocols. - - http://git-wip-us.apache.org/repos/asf/polygene-java/blob/fba4bdf6/manual/src/docs/tutorials/howto-writing-docs.txt ---------------------------------------------------------------------- diff --git a/manual/src/docs/tutorials/howto-writing-docs.txt b/manual/src/docs/tutorials/howto-writing-docs.txt index 4f6d20b..92f7e3d 100644 --- a/manual/src/docs/tutorials/howto-writing-docs.txt +++ b/manual/src/docs/tutorials/howto-writing-docs.txt @@ -33,7 +33,7 @@ You need to install `asciidoc` and `docbook-xsl`. [[community-docs-overall-flow,Documentation Flow]] == Overall Flow == -TIP: To generate the website locally use `./gradlew -p manual website`. Output is in `~/manual/build/docs/website`. +TIP: To generate the website locally use `./gradlew website`. Output is in `~/manual/build/docs/website`. Each (sub)project has its own documentation, in 'src/docs/' and all the Asciidoc documents have the +.txt+ file extension. @@ -339,5 +339,3 @@ Useful links when configuring the docbook toolchain: * http://www.sagehill.net/docbookxsl/index.html * http://docbook.sourceforge.net/release/xsl/1.76.1/doc/html/index.html * http://docbook.sourceforge.net/release/xsl/1.76.1/doc/fo/index.html - - http://git-wip-us.apache.org/repos/asf/polygene-java/blob/fba4bdf6/manual/src/docs/website/home.txt ---------------------------------------------------------------------- diff --git a/manual/src/docs/website/home.txt b/manual/src/docs/website/home.txt index caf7d99..b280abb 100644 --- a/manual/src/docs/website/home.txt +++ b/manual/src/docs/website/home.txt @@ -23,7 +23,7 @@ = Polygene⢠= [IMPORTANT] -.Polygene⢠{revnumber} +.{revnumber} ==== This is the documentation for *Polygene⢠{revnumber}*. Use the version switcher on the left to browse other versions documentation. @@ -54,4 +54,3 @@ Qi4j⢠is pronounced "chee for jay". This website is out of scope to explain th facets and history of Qi, so we refer the interested to read the http://en.wikipedia.org/wiki/Qi[lengthy article] at Wikipedia. For us, Qi is the force/energy within the body, in this case the Java platform. Something that makes Java so much better, if it is found and channeled into a greater good. -
