From f8c5f58ce8b2b076d5874508873829a33cc545b0 Mon Sep 17 00:00:00 2001 From: Sarah Abouzainah Date: Tue, 12 Jan 2021 14:47:21 +0200 Subject: Add new rst guide files Issue-ID: CCSDK-3070 Issue-ID: CCSDK-3081 Signed-off-by: Sarah Abouzainah Change-Id: I25c2488ac1ad12966a357f11ecca6e630f440ec0 --- docs/ui/designer-guide.rst | 343 ++++++++++++++++++++ docs/ui/designer.rst | 385 ---------------------- docs/ui/hello-world-resource-resolution-cba.rst | 357 +++++++++++++++++++++ docs/ui/hello-world-script-executor-cba.rst | 407 ++++++++++++++++++++++++ 4 files changed, 1107 insertions(+), 385 deletions(-) create mode 100644 docs/ui/designer-guide.rst delete mode 100644 docs/ui/designer.rst create mode 100644 docs/ui/hello-world-resource-resolution-cba.rst create mode 100644 docs/ui/hello-world-script-executor-cba.rst (limited to 'docs/ui') diff --git a/docs/ui/designer-guide.rst b/docs/ui/designer-guide.rst new file mode 100644 index 000000000..bd1960726 --- /dev/null +++ b/docs/ui/designer-guide.rst @@ -0,0 +1,343 @@ + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright (C) 2019 IBM. + +.. _designer_guide: + +Designer Guide +============== +.. toctree:: + :maxdepth: 4 + +.. note:: + **How to Get Started with CDS Designer UI** + + If you’re new to CDS Designer UI and need to get set up, the following guides may be helpful: + + - :ref:`running_cds_ui_locally` + +Getting Started +--------------- +This is your CDS Designer UI guide. No matter how experienced you are or what you want to achieve, +it should cover everything you need to know — from navigating the interface to making the most of different features. + +What is CDS Designer UI? +------------------------ ++----------------------------------------------+--------------+ +| CDS Designer UI is a framework to automate | | +| the **resolution of resources** for | |image1| | +| **instantiation** and any **config** | | +| provisioning operation, such as day0, day1, | | +| or day2 configuration. | | +| | | +| | | +| CDS has both **design-time** and | | +| **run-time** activities; during design time, | | +| **Designer** can **define** what **actions** | | +| are required for a given service, along with | | +| anything comprising the action. The design | | +| produces a :ref:`CBA Package ` | | +| | | +| | | +| Its **content** is driven from a **catalog** | | +| of **reusable data dictionary** and | | +| **component**, delivering a reusable and | | +| simplified **self-service** experience. | | +| | | +| CDS modeling is mainly based on **the TOSCA | | +| standard**, using JSON as a representation. | | ++----------------------------------------------+--------------+ + +What's new? +----------- ++----------------------+----------------------+----------------------+ +| |image2| | |image3| | |image4| | +| | | | +| Create full CBA | Import old packages | Create sophisticated | +| packages from | for edit and | package workflows in | +| built-in forms | collaboration | a no-code graphical | +| without programming | | designer | +| | | | +| |image5| | |image6| | |image7| | +| | | | +| Customizable CBA | Easily create and | Integration between | +| Package actions | manage lists of data | CDS UI and SDC | +| | via interface (Data | Services | +| | Dictionary, | | +| | controller catalog, | | +| | and config | | +| | management) | | ++----------------------+----------------------+----------------------+ + +Overview of CDS Interface +------------------------- +Full CDS UI screens are available in `InVision `__ + +|image8| + +1. **CDS main menu:** Access all CDS module list including Packages, Data Dictionary, Controller Catalog, etc. +2. **Profile:** Access user profile information +3. **Module Title:** See the current module name and the total number of items in the module list +4. **Module list:** View all active items in module and tools for search and filtering + +CBA Packages +------------ + +Package List +~~~~~~~~~~~~ +It gives you quick access to all and most recent created/edit packages + +|image9| + +1. **Module Tabs:** Access All, Deployed, Under Construction, or Archived packages +2. **Search:** Search for a package by title +3. **Filter:** Filter packages by package tags +4. **Package Sort:** Sort packages by recent or alphanumeric (name) or version +5. **List Pagination:** navigate between package list pages +6. **Create Package:** Create a new CBA package +7. **Import Package:** Import other packages that are created previously on CDS Editor or Designer or created by other/current user +8. **Package box:** It shows a brief detail of the package and gives access to some actions of the package +9. **Deployed package indicator** +10. **Package name and version** +11. **More menu:** Access a list of actions including Clone, Archive, Download, and Delete +12. **Last modified:** Shows user name and date and time of last modifications made in the package +13. **Package Description** +14. **Package Tags** +15. **Collaborators:** See who's collaborating to edit in the package +16. **Configuration button:** Go directly to package configuration +17. **Designer Mode:** It indicates package mode (Designer, Scripting, and Generic scripting) and by clicking on it, it will load to mode screen + +Create a New CBA Package +------------------------ + +User Flow +~~~~~~~~~ + +|image10| + +Create a New Package +~~~~~~~~~~~~~~~~~~~~ +You can create a new CBA Package by creating a new custom package or by import a package file that is already created before. + +.. note:: + **Create/Import Package** + You can’t create/import a CBA package that has the same name and version + of an existing package. Packages can be in the same name but in + different version numbers (ex., Package one v1.0.0 & Package one v1.0.1). + +**Create a New Custom CBA Package** +From the Packages page, click on the **Create Package** button to navigate to **Package** **Configuration** + +|image11| + +:ref:`MetaData ` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +In **MetaData Tab,** select Package Mode, enter package Name, Version, +Description and other configurations + +|image12| + +Once you fill in all required inputs, you can save this package by clicking the **Save** button in the Actions menu + +|image13| + +**Package Info Box:** It is in top of configurations tabs and it appears after you save a package for the first time + +|image14| + +You can continue adding package configuration or go directly to the **Designer Mode** screen from Package info box + +All changes will be saved when you click on the **Save** button + +To close the package configuration and go back to the Package list, navigate to the top left in breadcrumb and click the **CBA Packages** +link or click on the **Packages** link in the Main menu. + +:ref:`Template & Mapping