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-13909 Refresh and Streamline Project README #9426

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

exceptionfactory
Copy link
Contributor

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 Central
  • javadoc link to Javadocs for nifi-api with latest version
  • license indicator with Apache-2.0 based on GitHub project LICENSE declaration
  • issues link to Apache Jira
  • contact links to Developers and Users mailing lists
  • follow link to LinkedIn page
  • follow link to X

Many 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 the README.md files for these projects.

The Developing and Running sections are streamlined to avoid unnecessary directory and version information, retaining the commands to run.

The Documentation and Getting 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

  • Pull Request title starts with Apache NiFi Jira issue number, such as NIFI-00000
  • Pull Request commit message starts with Apache NiFi Jira issue number, as such NIFI-00000

Pull Request Formatting

  • Pull Request based on current revision of the main branch
  • Pull Request refers to a feature branch with one commit containing changes

Verification

Please indicate the verification steps performed prior to pull request creation.

Build

  • Build completed using mvn clean install -P contrib-check
    • JDK 21

Licensing

  • New dependencies are compatible with the Apache License 2.0 according to the License Policy
  • New dependencies are documented in applicable LICENSE and NOTICE files

Documentation

  • Documentation formatting appears as expected in rendered files

@EndzeitBegins
Copy link
Contributor

Looks good, thank you for the adjustments @exceptionfactory. 👍🏻

- [Documentation](#documentation)
- [License](#license)
- [Export Control](#export-control)
[![NiFi API](https://img.shields.io/maven-central/v/org.apache.nifi/nifi-api.svg?label=nifi-api&logo=apachenifi&logoColor=ffffff&color=728e9b)](https://central.sonatype.com/artifact/org.apache.nifi/nifi-api)
Copy link
Contributor

Choose a reason for hiding this comment

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

What do you think about including the nifi maven plugin here too, as that's a separate project upon which nifi build depends?

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.

3 participants