main

Clone Tools
  • last updated a few seconds ago
Constraints
Constraints: committers
 
Constraints: files
Constraints: dates
Update docs side navigation to include new chapters and reorganize

Add a user manual chapter on migrating from Ant

  1. … 1 more file in changeset.
Add link to attribute based matching docs

Update left nav to link to new publishing chapter

Update left nav to link to new publishing chapter

Rename and update Authoring Maintainable Builds

  1. … 1 more file in changeset.
Move TOC links to Kotlin DSL Primer according to review comments

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

  1. … 2 more files in changeset.
Add Kotlin DSL chapter to TOC/navigation

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

  1. … 1 more file in changeset.
Fix top navigation and search display for DSL reference

  1. … 2 more files in changeset.
Add metadata about type of documentation for search purposes

  1. … 2 more files in changeset.
Add details of upgrading to Gradle 5.0 (#6761)

* Rename upgrading to Gradle 5.0 chapter

* Add Gradle 5.0 breaking changes to upgrade chapter

This commit groups and lists all the breaking changes that Gradle 5.0

introduces, many of which were earlier documented as deprecations.

* Try different headings in upgrade chapter

Trying out a change from "Changes in 4.x" to "Upgrading from 4.x and earlier".

This is to see whether it's clearer to readers that they must apply all

all sections up to and including the version they're upgrading from.

  1. … 2 more files in changeset.
Update docs newsletter form content

Ensure newsletter sign up is always protected by reCAPTCHA

  1. … 1 more file in changeset.
Improve header navigation for docs

  1. … 1 more file in changeset.
Add Upgradle Gradle 4.x user manual chapter

Authored by @pledbrook. See #6165

  1. … 2 more files in changeset.
Allow docs DSL samples to be switched when viewing locally

Restore lost newsletter subscription disclaimer in docs footer

  1. … 1 more file in changeset.
Add dedicated chapter on directory layout

- Describe rough structure of Gradle user home and project root

directory

- Document cache cleanup strategies

- Point to user guide from release notes

Resolves #6063.

  1. … 3 more files in changeset.
DO NOT MERGE. Temporarily fix JS for multi-lang samples to work locally

Remove from nav

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

  1. … 1 more file in changeset.
Draft Kotlin DSL user manual chapter

with only information about kotlin-dsl plugin compiler settings

  1. … 2 more files in changeset.
Include only necessary JS

Including the guides.js duplicates a bunch of stuff already done

in build-tool.js. The new multi-language sample handling JS has

been migrated to the CDN.

Add link to user manual PDF in navigation

  1. … 1 more file in changeset.
New navigation for user manual (revised) (#6162)

This is mostly about rearranging the elements of the left navigation so that it

presents more of a thread for users to follow. In addition:

- There is now just a single Tutorials link (which goes to Guides home page)

- There is a new plugin reference page that lists all the core plugins

- Direct links to plugin chapters have been removed from the nav

- There is a new third-party integration page in place of individual nav links

- The Extending Gradle section has been streamlined

- There is a new subsection Advanced Techniques under Authoring Gradle Builds

  1. … 2 more files in changeset.
Adopt Lato/Inconsolata font stack for docs

  1. … 1 more file in changeset.
Remove unneeded xsl version declaration from docs webpages

Move after-footer JS to footer.html so it is included in generated docs

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

    • -0
    • +58
    ./resources/after-footer.html
    • -0
    • +64
    ./resources/footer.html
    • -0
    • +328
    ./resources/header.html
  1. … 398 more files in changeset.