Skip to content

Commit

Permalink
Updated demo documentation
Browse files Browse the repository at this point in the history
Updated devnotes to match new Docker usage
Updated History for 0.9.1
  • Loading branch information
Chaffelson committed May 18, 2018
1 parent be1d451 commit 2d47a5f
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 7 deletions.
7 changes: 1 addition & 6 deletions docs/devnotes.rst
Expand Up @@ -19,12 +19,7 @@ Docker Test Environment

There is an Apache NiFi image available on Dockerhub::

docker pull apache/nifi:1.5.0

However this is released with the official Apache cadence; for development convenience I keep slightly upstream versions of the NiFi & NiFi-Registry docker images on::

docker pull chaffelson/nifi:latest
docker pull chaffelson/nifi-registry:latest
docker pull apache/nifi:latest

There are a couple of configuration files for launching various Docker environment configurations in ./test_env_config for convenience.

Expand Down
10 changes: 10 additions & 0 deletions docs/history.rst
Expand Up @@ -2,6 +2,16 @@
History
=======

0.9.1 (2018-05-18)
------------------

| Updated Demos for 0.9 release
**New Features**

* Added a new demo for Flow Development LifeCycle which illustrates the steps a user might automate to promote Versioned Flows between NiFi environments
* Check out nipyapi.demo.fdlc to see more details

0.9.0 (2018-05-16)
------------------

Expand Down
14 changes: 14 additions & 0 deletions docs/nipyapi-docs/nipyapi.demo.rst
@@ -1,3 +1,15 @@
FDLC
----

Importing this module provides further instructions for it's use.
It will guide you through the steps involved in flow promotion.

Note that it makes extensive use of Docker Containers.

Usage::

from nipyapi.demo.fdlc import *

Console
-------

Expand All @@ -22,6 +34,8 @@ This is intended to give the user an example of a secured environment.
May be combined with the Console to produce a secured environment with demo
objects.

Note that this demo makes extensive use of Docker Containers.

Usage::

from nipyapi.demo.secured_connection import *
Expand Down
2 changes: 1 addition & 1 deletion nipyapi/demo/fdlc.py
Expand Up @@ -364,7 +364,7 @@ def step_c_promote_change_to_prod_reg():
"\nRefresh your Prod NiFi tab to see that the Process Group has a "
"red UpArrow(⬆︎) icon indicating a new version is available for "
"deployment."
"\nPlease now call 'step_d_promote_change_to_prod_nifi()\n")
"\nPlease now call 'step_d_promote_change_to_prod_nifi()'\n")


def step_d_promote_change_to_prod_nifi():
Expand Down

0 comments on commit 2d47a5f

Please sign in to comment.