Uploaded image for project: 'Apache NiFi'
  1. Apache NiFi
  2. NIFI-162

Create overall documentation/engage theme on website

    XMLWordPrintableJSON

    Details

      Description

      Perspectives / Flow of Documentation:

      • Overview
        • What problem does NiFi solve?
        • What is the general design philosophy of NiFi?
        • What are some of the key features?
      • User Guide
        • Dataflow Manager
          • How to build flows
          • Create / Share / Use templates
          • How to monitor behavior/performance
          • Data Provenance
          • In-line documentation / change history
        • Observer
          • Read-only access
      • System Administration Guide
          • How to install
          • Best practice configuration
          • Security / Hardening
          • Controlling access/levels of access
      • Developer Guide
        • What are the extension points
        • What is a NAR and what does the Classloader hierarchy/model look like?
        • How to build extensions
        • Thinking about the right abstraction and considering cohesion/coupling for a processor or extension in general
        • Emphasis on the user experience - the in-line documentation, the naming of properties, is a custom UI needed, etc..
        • Key things to consider/design considerations/strengths/limitations
        • How to contribute to Apache NiFI

      These are meant to flow logically from top to bottom where we want to gain interest in reading further by explaining the 'why' / the 'context'. Then it flows into usage and capabilities of the application. Then we flow into how to extend the application's capabilities to suit your needs and to contribute back to the community.

        Attachments

        1. NIFI-162.patch
          4 kB
          Jennifer Patricia Barnabee
        2. NIFI-162.patch
          2.08 MB
          Jennifer Patricia Barnabee
        3. NIFI-162.patch
          15 kB
          Jennifer Patricia Barnabee

          Issue Links

            Activity

              People

              • Assignee:
                joewitt Joseph Witt
                Reporter:
                joewitt Joseph Witt
              • Votes:
                0 Vote for this issue
                Watchers:
                5 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: