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

MINIFICPP-746: carve and improve documentation #492

Closed
wants to merge 3 commits into from

Conversation

phrocker
Copy link
Contributor

Thank you for submitting a contribution to Apache NiFi - MiNiFi C++.

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 MINIFICPP-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:

  • 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?
  • If applicable, have you updated the NOTICE file?

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.

@phrocker phrocker changed the title Minificpp 746 Minificpp 746L: break out some docs & update docs while doing so Feb 28, 2019
@phrocker phrocker changed the title Minificpp 746L: break out some docs & update docs while doing so MINIFICPP-746: carve and improve documentation Feb 28, 2019
Copy link
Member

@apiri apiri left a comment

Choose a reason for hiding this comment

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

Definitely reads a lot more cleanly and is better organized. Only comment of import was concerning the host and port in the RPG ports.

CONFIGURE.md Outdated
name: fromnifi
max concurrent tasks: 1
Properties:
Port: 10443
Copy link
Member

Choose a reason for hiding this comment

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

Don't need Port and Host Name for our RPG ports unless I'm missing a condition of using the context service

CONFIGURE.md Outdated
name: tominifi
max concurrent tasks: 2
Properties:
Port: 10443
Copy link
Member

Choose a reason for hiding this comment

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

remove port & host name

CONFIGURE.md Outdated
## Documentation
See https://nifi.apache.org/minifi for the latest documentation.

## Contributing
Copy link
Member

Choose a reason for hiding this comment

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

Probably can nix this in favor of a link to CONTRIB.md

Copy link
Member

@apiri apiri left a comment

Choose a reason for hiding this comment

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

Thanks for the changes. Will merge

apiri pushed a commit to apiri/nifi-minifi-cpp that referenced this pull request Mar 1, 2019
This closes apache#492.

Signed-off-by: Aldrin Piri <aldrin@apache.org>
@asfgit asfgit closed this in 56b4648 Mar 1, 2019
nghiaxlee pushed a commit to nghiaxlee/nifi-minifi-cpp that referenced this pull request Jul 8, 2019
This closes apache#492.

Signed-off-by: Aldrin Piri <aldrin@apache.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants