Clone Tools
  • last updated a few seconds ago
Constraints
Constraints: committers
 
Constraints: files
Constraints: dates
include Kotlin DSL sample for chapter working_with_files (archivesWithJavaPlugin example)

Issue #6442

Signed-off-by: jnizet <jb@ninja-squad.com>

  1. … 25 more files in changeset.
Convert user manual to be generated by Asciidoctor only

This change replaces all embedded Docbook syntax from the user manual.

Asciidoctor files are now converted directly to HTML and PDF.

It not only greatly simplifies the user manual generation pipeline, but also it makes it faster.

I did the following for all user manual pages:

- [x] Adjusted links to other manual pages, DSL docs, and Javadocs where necessary.

Fixed a couple dozen broken links at least.

- [x] Convert samples XML from docbook to asciidoctor syntax

- [x] Converted wide tables to a more flexible list-based display

Important contributor differences from now on:

- Users must use a `<file>.adoc#` prefix for all cross-reference links.

This is _required_ to achieve working links in all 3 outputs: multi-page user manual, single-page user manual, and PDF.

- The manual PDF is no longer themed, and no longer has the list of examples links in the TOC.

- File names were changed from camelCased to snake_case to have a crystal clear 1-1 mapping between source to output.

- Section reference verification is now handled by Asciidoctor verbose mode.

- The single-page user manual has the same navigation as the multi-page manual for now.

- [Common Asciidoctor extensions](https://github.com/gradle/dotorg-docs/tree/master/docs-asciidoctor-extensions) are now used by Gradle Guides and the User Manual, however, the the web assets (CSS, JS, etc) are not yet merged.

These extensions are responsible for injecting the navigation and styles.

The header/footer/navigation HTML can now be found under `subprojects/docs/src/main/resources`.

  1. … 401 more files in changeset.
Create a new chapter on building Java projects (#4800)

Merge the following changes from @pledbrook:

* Create a new chapter on Java projects

This covers a general overview in the Building Java projects chapter and a

fleshed out example in the Java testing chapter of setting up integration tests

in a Java build.

* Prune the Java Plugin chapter

Much of the content was overlapping with the new Building Java & JVM projects

chapter, so it has now been removed. The chapter is now a pure reference.

* Add plugin reference chapter for Base Plugin

  1. … 20 more files in changeset.
Create a new chapter on building Java projects (#4800)

Merge the following changes from @pledbrook:

* Create a new chapter on Java projects

This covers a general overview in the Building Java projects chapter and a

fleshed out example in the Java testing chapter of setting up integration tests

in a Java build.

* Prune the Java Plugin chapter

Much of the content was overlapping with the new Building Java & JVM projects

chapter, so it has now been removed. The chapter is now a pure reference.

* Add plugin reference chapter for Base Plugin

  1. … 20 more files in changeset.
Favor using FileCollection.iterator() over FileCollection.getFiles()

In some cases it's cheaper to create the iterator than a full-blown Set.

  1. … 28 more files in changeset.
Fix and improve minor issues in files chapter

  1. … 4 more files in changeset.
Improved nested specs example in files chapter

  1. … 8 more files in changeset.
Incorporate more feedback into files chapter

  1. … 11 more files in changeset.
Convert table to definition list in files chapter

  1. … 3 more files in changeset.