Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NIFI-5413 Added additional documentation for PutMongoRecord and fixed… #2881

Closed
wants to merge 2 commits into from

Conversation

MikeThomsen
Copy link
Contributor

… a typo in RunMongoAggregation's documentation.

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?
  • If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?
  • If applicable, have you updated the LICENSE file, including the main LICENSE file under nifi-assembly?
  • If applicable, have you updated the NOTICE file, including the main NOTICE file found under nifi-assembly?
  • If adding new Properties, have you added .displayName in addition to .name (programmatic access) for each of the new properties?

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.

… a typo in RunMongoAggregation's documentation.
@lfrancke
Copy link
Member

+1 looks good to me (not a committer)

@zenfenan
Copy link
Contributor

Reviewing..

</p>
<p>
This processor does not support updates, deletes or upserts. The number of documents to insert at a time is controlled
by the <em>Insert Batch Size</em> configuration property. This value should be set to a reasonable size to ensure
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpick: Since these are all text and we are not actually introducing any cool HTML formatting, would it not be enough if we just add it to the processor's @CapabilityDescription itself?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, although Additional Details pages are always helpful, in this case I think this information is more important to be on the "front page", and any Additional Details (such as examples) would go here.

@MikeThomsen
Copy link
Contributor Author

@zenfenan updated.

@MikeThomsen
Copy link
Contributor Author

@zenfenan @mattyb149 can we close this?

Copy link
Contributor

@zenfenan zenfenan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry about being late. Was really busy the past couple of weeks.

+1 for the changes. LGTM. Merging to the master. Thanks @MikeThomsen and @mattyb149

@asfgit asfgit closed this in c755ed9 Aug 30, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants