name: Documentation
description: Report a problem with our documentation
labels: [ "a:documentation", "to-triage" ]
assignees: [ ]
body:
  - type: markdown
    attributes:
      value: |
        Please search related information in our [latest documentation](https://docs.gradle.org/current/userguide/userguide.html) before opening a documentation issue.

public abstract class ReleaseNotes {
    /**
     * The source markdown file for the release notes.
     */
    public abstract RegularFileProperty getMarkdownFile();

    /**
     * The base CSS file used by all documentation.
     */
    public abstract RegularFileProperty getBaseCssFile();

    /**
     * The release notes specific CSS file
     */
    public abstract RegularFileProperty getReleaseNotesCssFile();

    /**

        tasks.register("serveDocs", ServeDocs.class, task -> {
            task.setDescription("Runs a local webserver to serve generated documentation.");
            task.setGroup("documentation");

            int webserverPort = 8000;
            task.getJavaLauncher().set(
                task.getProject().getExtensions().getByType(JavaToolchainService.class)

    subprojects:
      - 'platforms/core-runtime/'
  - core_runtime:
    name: 'core_runtime'
    subprojects:
      - 'platforms/core-runtime/'
  - documentation:
    name: 'documentation'
    subprojects:
      - 'platforms/documentation/'
  - extensibility:
    name: 'extensibility'
    subprojects:
      - 'subprojects/plugin-development/'
      - 'subprojects/plugin-use/'

 * </ul>
 *
 * Produces the following:
 * <ul>
 * <li>A docbook book XML file containing the reference.</li>
 * <li>A meta-data file containing information about where the canonical documentation for each class can be found:
 * as dsl doc, javadoc or groovydoc.</li>
 * </ul>
 */
@CacheableTask
abstract class AssembleDslDocTask extends DefaultTask {
    @PathSensitive(PathSensitivity.NONE)
    @InputFile

    name: 'build_infrastructure'
  - core_configuration:
    name: 'core_configuration'
  - core_execution:
    name: 'core_execution'
  - core_runtime:
    name: 'core_runtime'
  - documentation:
    name: 'documentation'
  - enterprise:
    name: 'enterprise'
  - extensibility:
    name: 'extensibility'
  - ide:
    name: 'ide'
  - jvm:
    name: 'jvm'
  - native:
    name: 'native'
  - software:

# its own file.

on:
  - pr_created
  - commit

automations:

  # Add the a:documentation label to docs-only changes
  docs_only:
    if:
      - {{ ('misc_labels' | isEnabledAutomation(pr)) }}
      - {{ is.docs }}
    run:
      - action: add-label@v1
        args:
          label: 'a:documentation'

  # Add the a:chore label and auto-approve formatting-only changes
  formatting_only:
    if:

    implementation("org.jetbrains.dokka:dokka-core")

    testImplementation(gradleTestKit())
}

gradlePlugin {
    plugins {
        register("gradleDocumentation") {
            id = "gradlebuild.documentation"
            implementationClass = "gradlebuild.docs.GradleBuildDocumentationPlugin"
        }
    }

        name = "Publish Branch Snapshot (from Quick Feedback)"
        description = "Deploys a new distribution snapshot for the selected build/branch. Does not update master or the documentation."

        val triggerName = this.triggerName

        params {
            param("branch.qualifier", "%dep.${RelativeId("Check_Stage_${triggerName}_Trigger")}.teamcity.build.branch%")
            text(

/**
 * Transforms userguide source into docbook, replacing custom XML elements.
 *
 * Takes the following as input:
 * <ul>
 * <li>A source docbook XML file.</li>
 * <li>Meta-info about the canonical documentation for each class referenced in the document, as produced by {@link gradlebuild.docs.dsl.docbook.AssembleDslDocTask}.</li>
 * </ul>
 *
 */
@CacheableTask
abstract class UserGuideTransformTask extends DefaultTask {