Adding CQA Retriever
This commit is contained in:
57
CQA_Retriever/README.md
Normal file
57
CQA_Retriever/README.md
Normal file
@@ -0,0 +1,57 @@
|
||||
# CQA Retriever Package
|
||||
|
||||
- [Hub Package Readme](_studio_dependencies/README.md)
|
||||
- [Widget Readme](widget/<widget_name>/_studio_dependencies/README.md)
|
||||
|
||||
# Contributing
|
||||
|
||||
- [Setup Widget Development](widget/README.md)
|
||||
|
||||
## Studio
|
||||
|
||||
Items which are provided to IVA Studio's Workspace and publications are in a
|
||||
\_studio_dependencies directory.
|
||||
|
||||
Each widget provided in this package has its own directory under widget/
|
||||
|
||||
## Hub Package
|
||||
|
||||
Hub Package is configured through a few locations. Utilize the structure
|
||||
below to understand the relationship and purpose of the different
|
||||
files and locations.
|
||||
|
||||
File content will have instances of {{ Hub Version }} replaced with the
|
||||
identified version based on git Tag.
|
||||
|
||||
```
|
||||
/
|
||||
├───\_studio\_dependencies/
|
||||
│ ├───ConversationFlowExport/ -- Export of example conversation flows
|
||||
│ ├───DynamicQuery/
|
||||
│ ├───Engagement/
|
||||
│ ├───GlobalVariable/
|
||||
│ ├───ProxyScript/
|
||||
│ ├───README.md -- Hub Readme Document
|
||||
│ └───HubPackage.json -- Hub Name/Description and Official Verint Package
|
||||
└───widget/
|
||||
├───README.md -- General Development documentation
|
||||
├───{widgetName}/
|
||||
│ ├───\_studio\_dependencies/
|
||||
│ │ └───README.md -- Widget Readme Document
|
||||
│ ├───widget.config.json -- Widget Name and Description
|
||||
│ └───README.md -- Development Notes for specific widget
|
||||
└───{widgetName2}/
|
||||
```
|
||||
|
||||
### Versioning
|
||||
|
||||
Publication and versioning is determined by repository tags.
|
||||
|
||||
v1.0.0-alpha - This will indicate an alpha build (draft, alpha, beta) are
|
||||
supported and anything else will result in a draft.
|
||||
|
||||
The published commit will be stored and used to compare with the new tag. The semantic version change will determine the increment type (MAJOR, MINOR, PATCH).
|
||||
|
||||
If the working directory has changes (is dirty), then it will publish as a draft-PATCH.
|
||||
|
||||
If publishing a version tag v1.0.0 then it will be marked as published.
|
||||
Reference in New Issue
Block a user