Clone Tools
  • last updated a few seconds ago
Constraints: committers
Constraints: files
Constraints: dates
Fix dead internal links

  1. … 28 more files in changeset.
Fix dead internal links

  1. … 28 more files in changeset.
Add links to further reading from task tutorial

doc: declaration order of task dependencies

Signed-off-by: Simon Legner <Simon.Legner@gmail.com>

Remove tutorials from user manual (#7759)

Implements dotorg-docs#126. I had to also remove a few references to the old

tutorial chapters.

  1. … 4 more files in changeset.
Rejig the user manual navigation

I've removed the link to the Using the Build Cache Guide as it wasn't clear

what the difference was with the Enabling and Configuring the Build Cache was.

To make up for its removal, the Guide is prominently linked from the user

manual chapter.

I've also reordered the Gradle API entries to improve the look by keeping the

Groovy DSL entries together and the Kotlin DSL ones.

Finally, I removed the Standard Gradle Plugins page because it overlaps with

the plugin reference page.

  1. … 4 more files in changeset.
Kotlin DSL samples for Writing Build Scripts user manual chapter

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

  1. … 30 more files in changeset.
docs/build_scripts_basics refine prose around samples

to account for the two DSLs

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

docs/build_scripts_basics add Kotlin DSL samples

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

  1. … 48 more files in changeset.
docs/build_scripts_basics fix three include::sample macro usages

tag= is not supported, only tags= is

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

docs/build_scripts_basics remove task << section

as this PR will target 5.0-RC1 and there's no Kotlin equivalent

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

  1. … 3 more files in changeset.
docs/build_scripts_basics move samples to groovy/ subdir

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

  1. … 90 more files in changeset.
docs/build-script-basics use the include::sample macro

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

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`.

    • -135
    • +246
  1. … 401 more files in changeset.
Rename user manual asciidoc files to snake_case

This makes the file names match the output HTML file names,

allowing for us to convert the user manual to asciidoc only.

See also #5837

    • -0
    • +287
  1. … 170 more files in changeset.