...

Documentation Contributions

System-level documentation

System-level and overview documentation such as:

• Administration Guide,
• Developer's Guide,
• User's Guide,
• Overview,
• etc.

Are is located in '<code checkout location>/nifi-docs/src/main/asciidoc'.
Tools available to facilitate documentation generation are available at Editing AsciiDoc with Live Preview.asciidoc' and can be changed by making changes to the ASCIIdoc files and following the code contribution process described in "Providing code or documentation contributions" section of this document.

Tools available to facilitate documentation generation are available at Editing AsciiDoc with Live Preview.

Component-level documentation

Component level documentation can be contributed to by making direct modifications to the source code of the relevant component. Generally the documentation of components is performed by adding the relevant details to the following annotations

@CapabilityDescription( "The overall description of the component would go here..." )

and the description field of annotations such as:

@DynamicProperty( description = "The description of the dynamic property would go here...")

and the description method of Component Properties and Relationships

PropertyDescriptor.Builder()
        .name("Property Name")
        .description("The description of the Property would go here...")
 
Relationship.Builder()
        .name("name-of-the-relationship")
        .description("The description of the relationship would go here... ")
        .build();

When the documentation of a processor is particularly complex (e.g, may include very long descriptions or images), a contributor may chose to use NiFi's capability to automatically link additional documentation to a processor.

In this case the contributor may extend documentation by performing changes to 'additionalDetails.htm'. As described in the Developer's Guide, this file should exist within a directory whose name is the fully-qualified name of the Processor, and this directory’s parent should be named docs and exist in the 'resources' directory of a particular processor bundle.

Image Added

As with other contributions, component level documentation should follow the process described in "Providing code or documentation contributions" section of this document. 

Create a ticket for new bugs or features

Run into a bug or think there is something that would benefit the project?  Regardless if you have the time to provide the fix or implementation, we encourage any such items to be filed as an issue at the Apache NiFi JIRA.

Anchor
providingCodeOrDocumentationContribution providingCodeOrDocumentationContribution

Providing code or documentation contributions

The source is hosted at https://git-wip-us.apache.org/repos/asf/nifi.git

...

@CapabilityDescription(