Skip to content

NIFI-12173 - Nifi Registry there's no documentation about OIDC connection#7842

Closed
marcelo225 wants to merge 10 commits intoapache:mainfrom
marcelo225:main
Closed

NIFI-12173 - Nifi Registry there's no documentation about OIDC connection#7842
marcelo225 wants to merge 10 commits intoapache:mainfrom
marcelo225:main

Conversation

@marcelo225
Copy link
Contributor

Summary

NIFI-12173

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-12173
  • Pull Request commit message starts with Apache NiFi Jira issue number, as such NIFI-12173

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

Copy link
Contributor

@exceptionfactory exceptionfactory 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 proposing this improvement @marcelo225, this is definitely an area where NiFi Registry is lacking documentation.

Unfortunately, the Registry implementation of OpenID Connect has some notable differences from NiFi itself, so the documentation section from the NiFi Admin Guide cannot be copied and pasted. In order to make some progress, however, removing the descriptive paragraphs and starting with just the table of properties would be helpful.

If you are interested in digging into the Registry OIDC implementation and updating the description to match, that's great. On the other hand, if you would like to move forward incrementally, focusing on the properties would be the best option.

@exceptionfactory exceptionfactory added the type: docs Pull Requests for changes to documentation label Oct 6, 2023
Copy link
Contributor

@exceptionfactory exceptionfactory left a comment

Choose a reason for hiding this comment

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

@marcelo225 On further review, removing several paragraphs copied from the NiFi description should be sufficient for this documentation update to proceed. Please see the detailed comments, thanks!

marcelo225 and others added 7 commits October 17, 2023 15:53
…sciidoc/administration-guide.adoc

Co-authored-by: exceptionfactory <exceptionfactory@apache.org>
…sciidoc/administration-guide.adoc

Co-authored-by: exceptionfactory <exceptionfactory@apache.org>
…sciidoc/administration-guide.adoc

Co-authored-by: exceptionfactory <exceptionfactory@apache.org>
…sciidoc/administration-guide.adoc

Co-authored-by: exceptionfactory <exceptionfactory@apache.org>
…sciidoc/administration-guide.adoc

Co-authored-by: exceptionfactory <exceptionfactory@apache.org>
…sciidoc/administration-guide.adoc

Co-authored-by: exceptionfactory <exceptionfactory@apache.org>
…sciidoc/administration-guide.adoc

Co-authored-by: exceptionfactory <exceptionfactory@apache.org>
@marcelo225
Copy link
Contributor Author

@exceptionfactory I'm done with it!

Copy link
Contributor

@exceptionfactory exceptionfactory 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 making the adjustments @marcelo225, the latest version looks good! +1 merging

exceptionfactory added a commit that referenced this pull request Oct 18, 2023
This closes #7842

Co-authored-by: David Handermann <exceptionfactory@apache.org>
Signed-off-by: David Handermann <exceptionfactory@apache.org>
(cherry picked from commit 0fce806)
@exceptionfactory exceptionfactory added the hacktoberfest-accepted Hacktoberfest Accepted label Oct 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

hacktoberfest-accepted Hacktoberfest Accepted type: docs Pull Requests for changes to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants