Skip to content
This repository was archived by the owner on Jul 21, 2023. It is now read-only.

Commit ebe3c14

Browse files
SethLaskySethLasky
and
SethLasky
authored
Add checklist for adding a new processor to the docs (#55) (#56)
Co-authored-by: SethLasky <seth.lasky@deciphernow.com>
1 parent e68e4d7 commit ebe3c14

File tree

2 files changed

+19
-1
lines changed

2 files changed

+19
-1
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,3 +66,21 @@ Here are some helpful links for navigating and using NiFi in general as well as
6666
* https://nifi.apache.org/docs/nifi-docs/html/user-guide.html
6767
* https://nifi.apache.org/docs/nifi-docs/html/getting-started.html
6868
* https://nifi.apache.org/docs/nifi-docs/html/administration-guide.html
69+
70+
71+
## Requirements for adding a processor to the SDK
72+
To add a processor to the SDK these are the things you need to do in order to make it accessible using the current process outlined in these docs:
73+
74+
1. Add a reference to the processor's main class to [./gmd-sdk/nifi-data-processors/src/main/resources/META-INF/services/org.apache.nifi.processor.Processor](./gmd-sdk/nifi-data-processors/src/main/resources/META-INF/services/org.apache.nifi.processor.Processor).
75+
76+
2. Update the release version for the project. The current list of files that need to be changed/hold references to the current version:
77+
* [./gmd-sdk/pom.xml](./gmd-sdk/pom.xml)
78+
* [./gmd-sdk/nifi-data-processors/pom.xml](./gmd-sdk/nifi-data-processors/pom.xml)
79+
* [./gmd-sdk/nifi-data-nar/pom.xml](./gmd-sdk/nifi-data-processors/pom.xml)
80+
* [./gmd-sdk/docker-compose.yml](./gmd-sdk/nifi-data-processors/pom.xml)
81+
82+
3. Add a note to [./gmd-sdk/CHANGELOG.md](./gmd-sdk/CHANGELOG.md) listing the new processor and release version.
83+
84+
4. Add a documentation page for the processor to [./doc](./doc). See examples in that directory for how the page should look.
85+
86+
5. Add a reference to the documentation above to [./doc/README.md](./doc/README.md)

doc/GetFileProperties.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# GetOidForPath
1+
# GetFileProperties
22

33
## Description:
44

0 commit comments

Comments
 (0)