Skip to content

Comments

NIFI-3799 - added input requirement info for processor documentation#1756

Closed
pvillard31 wants to merge 1 commit intoapache:masterfrom
pvillard31:NIFI-3799
Closed

NIFI-3799 - added input requirement info for processor documentation#1756
pvillard31 wants to merge 1 commit intoapache:masterfrom
pvillard31:NIFI-3799

Conversation

@pvillard31
Copy link
Contributor

Thank you for submitting a contribution to Apache NiFi.

In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:

For all changes:

  • Is there a JIRA ticket associated with this PR? Is it referenced
    in the commit message?

  • Does your PR title start with NIFI-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.

  • Has your PR been rebased against the latest commit within the target branch (typically master)?

  • Is your initial contribution a single, squashed commit?

For code changes:

  • Have you ensured that the full suite of tests is executed via mvn -Pcontrib-check clean install at the root nifi folder?
  • Have you written or updated unit tests to verify your changes?

For documentation related changes:

  • Have you ensured that format looks appropriate for the output in which it is rendered?

Note:

Please ensure that once the PR is submitted, you check travis-ci for build issues and submit an update to your PR as soon as possible.

@jvwing
Copy link
Contributor

jvwing commented May 23, 2017

Reviewing...

@jvwing
Copy link
Contributor

jvwing commented May 24, 2017

@pvillard31 - Everything works well in my testing. Why add the notation to the bottom of the Description section, rather than creating a new section with heading? For example, the Restricted section seems comparable, but it has a heading and then the text describing the restriction under the heading.

@pvillard31
Copy link
Contributor Author

Hey @jvwing! Thanks for the review, you're right following the same "style" is more consistent. I updated the PR to follow the same approach as for restricted components.

@asfgit asfgit closed this in fb7d6d1 May 24, 2017
@jvwing
Copy link
Contributor

jvwing commented May 24, 2017

Thanks for that change, @pvillard31, it looks good.

@pvillard31
Copy link
Contributor Author

Thanks @jvwing

mattyb149 pushed a commit to mattyb149/nifi that referenced this pull request Nov 30, 2017
Added input requirement info for processor documentation

This closes apache#1756.

Signed-off-by: James Wing <jvwing@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants