userguide.adoc

Clone Tools
  • last updated a few seconds ago
Constraints
Constraints: committers
 
Constraints: files
Constraints: dates
Update reference to VS2017 to VS2019

Merge remote-tracking branch 'origin/release'

* origin/release:

Link to fixed issues in release notes

Bump to 5.6.1

Prepare for 5.6.2

Make sure the memory leak tests for workers use separate daemons

Fix tests

Fix typo

Add test for legacy worker API as well

Use a non-decorated fork options when creating fork options for worker daemon

Reproduce OOM with out-of-process worker API

Add build cache training promotion link to selected docs

Remove duplicate project dependency from Eclipse classath when project is referenced with different configuration

  1. … 7 more files in changeset.
Add build cache training promotion link to selected docs

  1. … 4 more files in changeset.
Update .com userguide links

Add anchor check to dead link tasks

* Improve dead links detector

* Fix dead links

  1. … 45 more files in changeset.
Add anchor check to dead link tasks

* Improve dead links detector

* Fix dead links

* Make dead link detection a build step

  1. … 41 more files in changeset.
Add anchor check to dead link tasks

* Improve dead links detector

* Fix dead links

  1. … 45 more files in changeset.
Add anchor check to dead link tasks

* Improve dead links detector

* Fix dead links

  1. … 45 more files in changeset.
Change a few Groovy HTTP links in docs to HTTPS

  1. … 6 more files in changeset.
Change a few Groovy HTTP links in docs to HTTPS

  1. … 17 more files in changeset.
Correct grammar in docs (#8209)

Fix link to installation doc

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.