From 4da836e448fb55ddf9add9a4918c0c985ed3849f Mon Sep 17 00:00:00 2001 From: Saryu Shah Date: Fri, 30 Mar 2018 18:12:47 +0000 Subject: Documentation Update Release Template Documentation Update Release Template ------------------------------------------------------------- Change-Id: I827712a68820bccad0dcb1534cb96d5dd8bdb128 Issue-ID: POLICY-536 Signed-off-by: Saryu Shah --- docs/platform/mat_archetype_checkparams.png | Bin 0 -> 84272 bytes docs/platform/mat_local_archetypes.png | Bin 0 -> 75700 bytes docs/platform/mat_nexus_local_catalog.png | Bin 0 -> 25584 bytes docs/platform/mat_select_archetypes.png | Bin 0 -> 78975 bytes docs/platform/modAmsterTemplate.rst | 40 +++++++++++++++++++++++----- 5 files changed, 34 insertions(+), 6 deletions(-) create mode 100755 docs/platform/mat_archetype_checkparams.png create mode 100755 docs/platform/mat_local_archetypes.png create mode 100755 docs/platform/mat_nexus_local_catalog.png create mode 100755 docs/platform/mat_select_archetypes.png diff --git a/docs/platform/mat_archetype_checkparams.png b/docs/platform/mat_archetype_checkparams.png new file mode 100755 index 000000000..0c43126a2 Binary files /dev/null and b/docs/platform/mat_archetype_checkparams.png differ diff --git a/docs/platform/mat_local_archetypes.png b/docs/platform/mat_local_archetypes.png new file mode 100755 index 000000000..5c80eb5eb Binary files /dev/null and b/docs/platform/mat_local_archetypes.png differ diff --git a/docs/platform/mat_nexus_local_catalog.png b/docs/platform/mat_nexus_local_catalog.png new file mode 100755 index 000000000..ca41898f3 Binary files /dev/null and b/docs/platform/mat_nexus_local_catalog.png differ diff --git a/docs/platform/mat_select_archetypes.png b/docs/platform/mat_select_archetypes.png new file mode 100755 index 000000000..a4bc088bc Binary files /dev/null and b/docs/platform/mat_select_archetypes.png differ diff --git a/docs/platform/modAmsterTemplate.rst b/docs/platform/modAmsterTemplate.rst index c08dbb641..67892ebb1 100644 --- a/docs/platform/modAmsterTemplate.rst +++ b/docs/platform/modAmsterTemplate.rst @@ -31,27 +31,54 @@ Installing the Archetype Project in Eclipse .. image:: mat_configure.JPG -**STEP 5:** Click "Add Remote Catalog..." +**STEP 5:** Add a Remote and/or a Local catalog + +**STEP 5.1:** Add a Remote Catalog to find the ONAP staged drools-applications + +**STEP 5.1.1:** Click "Add Remote Catalog..." .. image:: mat_add_local_catalog.JPG -**STEP 6:** Add the ONAP Staging repository archetype-catalog.xml with a description if desired. Click "OK" then "Apply", then "OK". +**STEP 5.1.2:** Add the ONAP Staging repository archetype-catalog.xml with a description if desired. Click "OK" then "Apply", then "OK". .. image:: mat_nexus_catalog.JPG -**STEP 7:** The ONAP staging archetypes are now an option: +**STEP 5.1.3:** The ONAP staging archetypes are now an option: .. image:: mat_archetypes.JPG -**STEP 8:** Highlight the option with the Artifact Id "archetype-cl-amsterdam" and hit next. The following screen allows the user to modify some of the configurable parameters of the control loop. For this demo the default parameters that are already populated will be used. Fill out the Groud Id, Artifact Id, Version, and Package and hit "Finish". For the demo the following is used: +**STEP 5.2:** Add a Local Catalog to find a local drools-applications in your .m2 local repository + +**STEP 5.2.1:** Click "Add Local Catalog..." + + .. image:: mat_add_local_catalog.JPG + +**STEP 5.2.2:** Browse to or type in the path to your .m2 repository, give it a name and click "OK" + + .. image:: mat_nexus_local_catalog.png + +**STEP 5.2.3:** The new local repository appears on the catalog list, click "Apply and Close" + + .. image:: mat_local_archetypes.png + +**STEP 6:** If you wish to use a snapshot version of drools-applications, make sure to check the "Include snapshot archetypes" box. Highlight the option with the Artifact Id "archetype-cl-amsterdam" and click next. + + .. image:: mat_select_archetypes.png + +**STEP 7:** The following screen allows the user to modify some of the configurable parameters of the control loop. For this demo the default parameters that are already populated will be used. Fill out the Groud Id, Artifact Id, Version, and Package and hit "Finish". For the demo the following is used: .. image:: mat_archetype_params.JPG -**STEP 9:** Depending on the IDE in use, an error may be generated about handling the kie-maven-plugin:6.5.0.Final:build plugin. This can be ignored, click "Finish" and then "OK" if a warning pops up about having build errors. +**NOTE:** If you are using a snapshot version of drools-applications. make sure that the "dependenciesVersion" variable value you specify matches the drools-applications artifact versions + + .. image:: mat_archetype_checkparams.png + + +**STEP 8:** Depending on the IDE in use, an error may be generated about handling the kie-maven-plugin:6.5.0.Final:build plugin. This can be ignored, click "Finish" and then "OK" if a warning pops up about having build errors. .. image:: mat_error.JPG -**STEP 10:** Amsterdam can now be seen in the Project Explorer: +**STEP 9:** Amsterdam can now be seen in the Project Explorer: .. image:: mat_amsterdam_project.JPG @@ -97,6 +124,7 @@ Running the PDP-D with the Amsterdam Controller End of Document +.. SSNote: Beijing release update. https://wiki.onap.org/display/DW/Modifying+the+Release+template .. SSNote: Wiki page ref. https://wiki.onap.org/display/DW/Modifying+the+Amsterdam+release+template -- cgit 1.2.3-korg