pluginIntro

Clone Tools
  • last updated a few seconds ago
Constraints
Constraints: committers
 
Constraints: files
Constraints: dates
Revert "Convert groovy samples to lazy tasks API"

This reverts commit 5201a50eb5eb42ad69f327c9f8b073c115653656.

  1. … 259 more files in changeset.
Convert `userguide` samples to lazy tasks API

  1. … 158 more files in changeset.
Convert groovy samples to lazy tasks API

  1. … 264 more files in changeset.
Prefer unambiguous apply<T>() overload

Signed-off-by: Paul Merlin <paul@gradle.com>

Include Kotlin DSL samples in the plugins doc chapter

See #6424

    • -0
    • +17
    ./groovy/build.gradle
    • -0
    • +1
    ./groovy/settings.gradle
    • -0
    • +18
    ./kotlin/build.gradle.kts
    • -0
    • +1
    ./kotlin/settings.gradle.kts
  1. … 105 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.
Externalize samples testing infrastructure

This change replaces UserGuideSamplesRunner with an external library

called sample-check. Sample discovery, execution, and normalization

is delegated to this library, with some custom normalizers remaining

in the Gradle codebase.

Samples output has become co-located with the sample code. Samples tests

must be run with Java 8+.

    • -0
    • +2
    ./pluginIntro.sample.conf
  1. … 782 more files in changeset.
Sample projects should provide root project name as best practice (#3730)

  1. … 240 more files in changeset.
Remove usage of --no-search-upwards and deprecate

  1. … 256 more files in changeset.
Use doLast instead of left shift operator in docs

+review REVIEW-6236

  1. … 105 more files in changeset.
Put back explanation of why class literal is not imported.

+review REVIEW-5010

  1. … 1 more file in changeset.
Renamed subprojects/gradle-(.+) to subprojects/$1

  1. … 6178 more files in changeset.