writing_build_scripts.adoc

Clone Tools
  • last updated a few seconds ago
Constraints
Constraints: committers
 
Constraints: files
Constraints: dates
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.
Revert "Use HTTPS for links to groovy docs from Javadoc"

This reverts commit 35342c85e520ea81ccc307743a40c053c957b99e.

  1. … 11 more files in changeset.
Use HTTPS for links to groovy docs from Javadoc

  1. … 11 more files in changeset.
Use a flatten directory for all adoc files

This commit reworks how asciidoctor files are processed,

by allowing to structure docs using subdirectories, while

maintaining consistent locations for resources, images, samples,

...

This works by flattening all adoc files into a resources

directory before processing. It means that while we can

use a directory tree to organize docs, we must make sure

not to use the same file name twice.

This makes it possible to compose files more easily. For

example, the dependency management docs can be read as

a single file, or individual files, or as chapters.

Technically speaking, we could remove the "userguideSinglePage"

task, but it's kept just because it's significantly slower

to build.

  1. … 7 more files in changeset.
Use a flatten directory for all adoc files

This commit reworks how asciidoctor files are processed,

by allowing to structure docs using subdirectories, while

maintaining consistent locations for resources, images, samples,

...

This works by flattening all adoc files into a resources

directory before processing. It means that while we can

use a directory tree to organize docs, we must make sure

not to use the same file name twice.

This makes it possible to compose files more easily. For

example, the dependency management docs can be read as

a single file, or individual files, or as chapters.

Technically speaking, we could remove the "userguideSinglePage"

task, but it's kept just because it's significantly slower

to build.

  1. … 7 more files in changeset.
Use a flatten directory for all adoc files

This commit reworks how asciidoctor files are processed,

by allowing to structure docs using subdirectories, while

maintaining consistent locations for resources, images, samples,

...

This works by flattening all adoc files into a resources

directory before processing. It means that while we can

use a directory tree to organize docs, we must make sure

not to use the same file name twice.

This makes it possible to compose files more easily. For

example, the dependency management docs can be read as

a single file, or individual files, or as chapters.

Technically speaking, we could remove the "userguideSinglePage"

task, but it's kept just because it's significantly slower

to build.

  1. … 7 more files in changeset.
Use a flatten directory for all adoc files

This commit reworks how asciidoctor files are processed,

by allowing to structure docs using subdirectories, while

maintaining consistent locations for resources, images, samples,

...

This works by flattening all adoc files into a resources

directory before processing. It means that while we can

use a directory tree to organize docs, we must make sure

not to use the same file name twice.

This makes it possible to compose files more easily. For

example, the dependency management docs can be read as

a single file, or individual files, or as chapters.

Technically speaking, we could remove the "userguideSinglePage"

task, but it's kept just because it's significantly slower

to build.

  1. … 7 more files in changeset.
Use a flatten directory for all adoc files

This commit reworks how asciidoctor files are processed,

by allowing to structure docs using subdirectories, while

maintaining consistent locations for resources, images, samples,

...

This works by flattening all adoc files into a resources

directory before processing. It means that while we can

use a directory tree to organize docs, we must make sure

not to use the same file name twice.

This makes it possible to compose files more easily. For

example, the dependency management docs can be read as

a single file, or individual files, or as chapters.

Technically speaking, we could remove the "userguideSinglePage"

task, but it's kept just because it's significantly slower

to build.

  1. … 7 more files in changeset.
Use a flatten directory for all adoc files

This commit reworks how asciidoctor files are processed,

by allowing to structure docs using subdirectories, while

maintaining consistent locations for resources, images, samples,

...

This works by flattening all adoc files into a resources

directory before processing. It means that while we can

use a directory tree to organize docs, we must make sure

not to use the same file name twice.

This makes it possible to compose files more easily. For

example, the dependency management docs can be read as

a single file, or individual files, or as chapters.

Technically speaking, we could remove the "userguideSinglePage"

task, but it's kept just because it's significantly slower

to build.

  1. … 7 more files in changeset.
Use a flatten directory for all adoc files

This commit reworks how asciidoctor files are processed,

by allowing to structure docs using subdirectories, while

maintaining consistent locations for resources, images, samples,

...

This works by flattening all adoc files into a resources

directory before processing. It means that while we can

use a directory tree to organize docs, we must make sure

not to use the same file name twice.

This makes it possible to compose files more easily. For

example, the dependency management docs can be read as

a single file, or individual files, or as chapters.

Technically speaking, we could remove the "userguideSinglePage"

task, but it's kept just because it's significantly slower

to build.

  1. … 7 more files in changeset.
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.
Fix prose around the extra properties sample

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

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 move samples to groovy/ subdir

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

  1. … 90 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.
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
    • +255
    ./writing_build_scripts.adoc
  1. … 170 more files in changeset.