NIFI-13909 Refresh and Streamline Project README #9426
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
NIFI-13909 Updates and simplifies the primary project
README.md
with additional badges and streamlined command examples.Additional badges include the following:
nifi-api
link to Maven Centraljavadoc
link to Javadocs fornifi-api
with latest versionlicense
indicator withApache-2.0
based on GitHub projectLICENSE
declarationissues
link to Apache Jiracontact
links toDevelopers
andUsers
mailing listsfollow
link to LinkedIn pagefollow
link to XMany of the badges include logo icons, and project colors in some cases.
The refreshed
Features
section highlights Python Processors and single sign-on, among others.Instead of including separate build information for MiNiFi and Registry, the new
Projects
section has links to theREADME.md
files for these projects.The
Developing
andRunning
sections are streamlined to avoid unnecessary directory and version information, retaining the commands to run.The
Documentation
andGetting Help
sections are removed, now covered under additional project badges.The
Export Control
section retains the previous wording, but contains an updated list of linked libraries and frameworks that provide encrypted communication and storage capabilities.Viewing the source branch for this pull request displays the rendered version of the README.md
Tracking
Please complete the following tracking steps prior to pull request creation.
Issue Tracking
Pull Request Tracking
NIFI-00000
NIFI-00000
Pull Request Formatting
main
branchVerification
Please indicate the verification steps performed prior to pull request creation.
Build
mvn clean install -P contrib-check
Licensing
LICENSE
andNOTICE
filesDocumentation