cob-cli 2.11.0 → 2.13.0

package/templates/backend/vuepress/others/vuepress/definition_contents_v234.json

@@ -0,0 +1,619 @@
+{
+    "id": null,
+    "name": "E-learning Contents",
+    "description": "@vuepress",
+    "duplicable": null,
+    "state": "enabled",
+    "fieldDefinitions": [
+        {
+            "id": null,
+            "name": "Metadata",
+            "required": null,
+            "description": "$group $expanded",
+            "condition": null,
+            "duplicable": false,
+            "fields": [
+                {
+                    "id": null,
+                    "name": "Descriptor",
+                    "required": "mandatory",
+                    "description": "$help[uri name part - no spaces or invalid url chars] $style[hide-in-group-edit]",
+                    "condition": null,
+                    "duplicable": false,
+                    "fields": [
+                        {
+                            "id": null,
+                            "name": "Parent Scope",
+                            "required": null,
+                            "description": "$auto.ref(Parent).field(Scope) $style[hide]",
+                            "condition": "Parent!",
+                            "duplicable": false,
+                            "fields": [],
+                            "order": 2,
+                            "rootField": false,
+                            "restricted": false,
+                            "defaultValue": null
+                        },
+                        {
+                            "id": null,
+                            "name": "Parent Path",
+                            "required": null,
+                            "description": "$auto.ref(Parent).field(Path) $style[hide]",
+                            "condition": "Parent!",
+                            "duplicable": false,
+                            "fields": [],
+                            "order": 3,
+                            "rootField": false,
+                            "restricted": false,
+                            "defaultValue": null
+                        },
+                        {
+                            "id": null,
+                            "name": "Parent SortableField",
+                            "required": null,
+                            "description": "$auto.ref(Parent).field(SortableField) $style[hide] $restricted(System)",
+                            "condition": "Parent!",
+                            "duplicable": false,
+                            "fields": [],
+                            "order": 4,
+                            "rootField": false,
+                            "restricted": true,
+                            "defaultValue": null
+                        },
+                        {
+                            "id": null,
+                            "name": "Scope",
+                            "required": null,
+                            "description": "$auto.text(Parent Scope,Descriptor).join(Parent Scope,Descriptor,'.') $instanceLabel",
+                            "condition": "Parent!",
+                            "duplicable": false,
+                            "fields": [],
+                            "order": 5,
+                            "rootField": false,
+                            "restricted": false,
+                            "defaultValue": null
+                        },
+                        {
+                            "id": null,
+                            "name": "Path",
+                            "required": null,
+                            "description": "$auto.text(Parent Path,Descriptor).join(Parent Path,Descriptor,'/') $instanceLabel",
+                            "condition": "Parent!",
+                            "duplicable": false,
+                            "fields": [],
+                            "order": 6,
+                            "rootField": false,
+                            "restricted": false,
+                            "defaultValue": null
+                        },
+                        {
+                            "id": null,
+                            "name": "SortableField",
+                            "required": null,
+                            "description": "$auto.text(Order,Parent SortableField,Descriptor).join(Parent SortableField,Order,Descriptor,'/') $style[hide]",
+                            "condition": "Parent!",
+                            "duplicable": false,
+                            "fields": [],
+                            "order": 7,
+                            "rootField": false,
+                            "restricted": false,
+                            "defaultValue": null
+                        },
+                        {
+                            "id": null,
+                            "name": "ParentFormat",
+                            "required": null,
+                            "description": "$auto.ref(Parent).field(Format) $style[hide] ",
+                            "condition": "Parent!",
+                            "duplicable": false,
+                            "fields": [],
+                            "order": 8,
+                            "rootField": false,
+                            "restricted": false,
+                            "defaultValue": null
+                        },
+                        {
+                            "id": null,
+                            "name": "Scope",
+                            "required": null,
+                            "description": "$auto.text(Descriptor).join('.',Descriptor,'.') $instanceLabel",
+                            "condition": "Parent=",
+                            "duplicable": false,
+                            "fields": [],
+                            "order": 9,
+                            "rootField": false,
+                            "restricted": false,
+                            "defaultValue": null
+                        },
+                        {
+                            "id": null,
+                            "name": "Path",
+                            "required": null,
+                            "description": "$auto.text(Descriptor).join('/',Descriptor,'/') ",
+                            "condition": "Parent=",
+                            "duplicable": false,
+                            "fields": [],
+                            "order": 10,
+                            "rootField": false,
+                            "restricted": false,
+                            "defaultValue": null
+                        },
+                        {
+                            "id": null,
+                            "name": "SortableField",
+                            "required": null,
+                            "description": "$auto.text(Descriptor).join('/',Descriptor,'/') $style[hide]",
+                            "condition": "Parent=",
+                            "duplicable": false,
+                            "fields": [],
+                            "order": 11,
+                            "rootField": false,
+                            "restricted": false,
+                            "defaultValue": null
+                        },
+                        {
+                            "id": null,
+                            "name": "Target",
+                            "required": null,
+                            "description": "$auto.ref(Parent).field(Target) $instanceDescription",
+                            "condition": "ParentFormat!",
+                            "duplicable": false,
+                            "fields": [],
+                            "order": 12,
+                            "rootField": false,
+                            "restricted": false,
+                            "defaultValue": null
+                        },
+                        {
+                            "id": null,
+                            "name": "Type",
+                            "required": null,
+                            "description": "$auto.ref(Parent).field(Type) $instanceDescription",
+                            "condition": "ParentFormat!",
+                            "duplicable": false,
+                            "fields": [],
+                            "order": 13,
+                            "rootField": false,
+                            "restricted": false,
+                            "defaultValue": null
+                        },
+                        {
+                            "id": null,
+                            "name": "Format",
+                            "required": null,
+                            "description": " $auto.text(id).join('chapter') $instanceDescription",
+                            "condition": "ParentFormat!",
+                            "duplicable": false,
+                            "fields": [],
+                            "order": 14,
+                            "rootField": false,
+                            "restricted": false,
+                            "defaultValue": null
+                        }
+                    ],
+                    "order": 1,
+                    "rootField": false,
+                    "restricted": false,
+                    "defaultValue": null
+                },
+                {
+                    "id": null,
+                    "name": "Parent",
+                    "required": null,
+                    "description": "$ref(E-learning Contents,-id:__instanceId__) $expanded $style[hide-inline]  $groupEdit $help[The parent SCOPE of this content in the hierarchy.]",
+                    "condition": null,
+                    "duplicable": false,
+                    "fields": [],
+                    "order": 15,
+                    "rootField": false,
+                    "restricted": false,
+                    "defaultValue": null
+                },
+                {
+                    "id": null,
+                    "name": "Visibility",
+                    "required": "mandatory",
+                    "description": "$[Public,*Restricted] $radio $groupEdit $instanceDescription",
+                    "condition": null,
+                    "duplicable": false,
+                    "fields": [
+                        {
+                            "id": null,
+                            "name": "Audience Group",
+                            "required": null,
+                            "description": "$groupEdit",
+                            "condition": "=Restricted",
+                            "duplicable": true,
+                            "fields": [],
+                            "order": 17,
+                            "rootField": false,
+                            "restricted": false,
+                            "defaultValue": null
+                        }
+                    ],
+                    "order": 16,
+                    "rootField": false,
+                    "restricted": false,
+                    "defaultValue": "Restricted"
+                },
+                {
+                    "id": null,
+                    "name": "Order",
+                    "required": null,
+                    "description": "$help[on a search result, with is used on book Indexs and menu cards] $groupEdit",
+                    "condition": null,
+                    "duplicable": false,
+                    "fields": [],
+                    "order": 18,
+                    "rootField": false,
+                    "restricted": false,
+                    "defaultValue": null
+                },
+                {
+                    "id": null,
+                    "name": "Tags",
+                    "required": null,
+                    "description": "$instanceDescription $groupEdit",
+                    "condition": null,
+                    "duplicable": false,
+                    "fields": [],
+                    "order": 19,
+                    "rootField": false,
+                    "restricted": false,
+                    "defaultValue": null
+                },
+                {
+                    "id": null,
+                    "name": "Type",
+                    "required": "mandatory",
+                    "description": "$[Tutorial,Howto,Reference,Explanation,Solution,SiteItem] $radio $groupEdit $expanded ",
+                    "condition": "ParentFormat=",
+                    "duplicable": false,
+                    "fields": [
+                        {
+                            "id": null,
+                            "name": "Target",
+                            "required": "mandatory",
+                            "description": "$[Everyone,User,Manager,Developer] $radio $instanceDescription $groupEdit $expanded",
+                            "condition": "=Tutorial,Howto,Reference,Explanation,Solution",
+                            "duplicable": false,
+                            "fields": [],
+                            "order": 21,
+                            "rootField": false,
+                            "restricted": false,
+                            "defaultValue": null
+                        },
+                        {
+                            "id": null,
+                            "name": "Format",
+                            "required": "mandatory",
+                            "description": "$[Book,SinglePage] $radio $instanceDescription $groupEdit $help[A 'Book' will have a sidebar to index SubContents while a 'SinglePages' won't]",
+                            "condition": "=Tutorial,Howto,Reference,Explanation,Solution",
+                            "duplicable": false,
+                            "fields": [],
+                            "order": 22,
+                            "rootField": false,
+                            "restricted": false,
+                            "defaultValue": null
+                        },
+                        {
+                            "id": null,
+                            "name": "SiteItemType",
+                            "required": "mandatory",
+                            "description": "$[Page,directory] $radio $instanceDescription $groupEdit",
+                            "condition": "=SiteItem",
+                            "duplicable": false,
+                            "fields": [],
+                            "order": 23,
+                            "rootField": false,
+                            "restricted": false,
+                            "defaultValue": null
+                        }
+                    ],
+                    "order": 20,
+                    "rootField": false,
+                    "restricted": false,
+                    "defaultValue": null
+                },
+                {
+                    "id": null,
+                    "name": "Live Content",
+                    "required": null,
+                    "description": "$auto.text(Path).join('/docs',Path) $link",
+                    "condition": "SiteItemType!directory",
+                    "duplicable": false,
+                    "fields": [],
+                    "order": 24,
+                    "rootField": false,
+                    "restricted": false,
+                    "defaultValue": null
+                }
+            ],
+            "order": 0,
+            "rootField": true,
+            "restricted": false,
+            "defaultValue": null
+        },
+        {
+            "id": null,
+            "name": "Content",
+            "required": null,
+            "description": "$group $expanded  $style[hide-in-group-edit]",
+            "condition": null,
+            "duplicable": false,
+            "fields": [
+                {
+                    "id": null,
+                    "name": "Guidelines",
+                    "required": null,
+                    "description": "$group $expanded $style[guidelines]",
+                    "condition": null,
+                    "duplicable": false,
+                    "fields": [
+                        {
+                            "id": null,
+                            "name": "A <a href=\"/docs/solutions/cob/learning/diataxis-documentation-framework/tutorials/\">tutorial</a> must help a beginner achieve basic competence with a product, so that they can go on to use the product for their own purposes.<br><br> Pay attention who the reader is (__Target__) and what the scope is (__Parent Path__)",
+                            "required": null,
+                            "description": "$group",
+                            "condition": "Type=Tutorial",
+                            "duplicable": false,
+                            "fields": [],
+                            "order": 27,
+                            "rootField": false,
+                            "restricted": false,
+                            "defaultValue": null
+                        },
+                        {
+                            "id": null,
+                            "name": "<a href=\"/docs/solutions/cob/learning/diataxis-documentation-framework/how-to-guides/\">How-to guides</a> can be thought of as recipes, directions that guide the reader through the steps to achieve a specific end.<br><br> Pay attention who the reader is (__Target__) and what the scope is (__Parent Path__)",
+                            "required": null,
+                            "description": "$group",
+                            "condition": "Type=Howto",
+                            "duplicable": false,
+                            "fields": [],
+                            "order": 28,
+                            "rootField": false,
+                            "restricted": false,
+                            "defaultValue": null
+                        },
+                        {
+                            "id": null,
+                            "name": "The only purpose of a <a href=\"/docs/solutions/cob/learning/diataxis-documentation-framework/reference/\">reference guide</a> is to describe, as succinctly as possible, and in an orderly way. Whereas the content of tutorials and how-to guides are led by needs of the user, reference material is led by the product it describes.<br><br> Pay attention who the reader is (__Target__) and what the scope is (__Parent Path__)",
+                            "required": null,
+                            "description": "$group",
+                            "condition": "Type=Reference",
+                            "duplicable": false,
+                            "fields": [],
+                            "order": 29,
+                            "rootField": false,
+                            "restricted": false,
+                            "defaultValue": null
+                        },
+                        {
+                            "id": null,
+                            "name": "<a href=\"/solutions/cob/learning/diataxis-documentation-framework/explanation/\">Explanation</a> clarifies, deepens and broadens the reader’s understanding of a subject.<br><br> Pay attention who the reader is (__Target__) and what the scope is (__Parent Path__)",
+                            "required": null,
+                            "description": "$group",
+                            "condition": "Type=Explanation",
+                            "duplicable": false,
+                            "fields": [],
+                            "order": 30,
+                            "rootField": false,
+                            "restricted": false,
+                            "defaultValue": null
+                        },
+                        {
+                            "id": null,
+                            "name": "Brief Description of a solution with advantages and motivation from lack of adequate alternatives.",
+                            "required": null,
+                            "description": "$group",
+                            "condition": "Type=Showcase,Solution",
+                            "duplicable": false,
+                            "fields": [],
+                            "order": 31,
+                            "rootField": false,
+                            "restricted": false,
+                            "defaultValue": null
+                        }
+                    ],
+                    "order": 26,
+                    "rootField": false,
+                    "restricted": false,
+                    "defaultValue": null
+                },
+                {
+                    "id": null,
+                    "name": "Name",
+                    "required": null,
+                    "description": "$instanceDescription",
+                    "condition": null,
+                    "duplicable": false,
+                    "fields": [
+                        {
+                            "id": null,
+                            "name": "Content",
+                            "required": "mandatory",
+                            "description": "$markdown  $style[shortMD]",
+                            "condition": "!",
+                            "duplicable": false,
+                            "fields": [],
+                            "order": 33,
+                            "rootField": false,
+                            "restricted": false,
+                            "defaultValue": null
+                        }
+                    ],
+                    "order": 32,
+                    "rootField": false,
+                    "restricted": false,
+                    "defaultValue": null
+                },
+                {
+                    "id": null,
+                    "name": "Name-PT",
+                    "required": null,
+                    "description": null,
+                    "condition": null,
+                    "duplicable": false,
+                    "fields": [
+                        {
+                            "id": null,
+                            "name": "Content-PT",
+                            "required": "mandatory",
+                            "description": "$markdown  $style[shortMD]",
+                            "condition": "!",
+                            "duplicable": false,
+                            "fields": [],
+                            "order": 35,
+                            "rootField": false,
+                            "restricted": false,
+                            "defaultValue": null
+                        }
+                    ],
+                    "order": 34,
+                    "rootField": false,
+                    "restricted": false,
+                    "defaultValue": null
+                },
+                {
+                    "id": null,
+                    "name": "Name-ES",
+                    "required": null,
+                    "description": null,
+                    "condition": null,
+                    "duplicable": false,
+                    "fields": [
+                        {
+                            "id": null,
+                            "name": "Content-ES",
+                            "required": "mandatory",
+                            "description": "$markdown  $style[shortMD]",
+                            "condition": "!",
+                            "duplicable": false,
+                            "fields": [],
+                            "order": 37,
+                            "rootField": false,
+                            "restricted": false,
+                            "defaultValue": null
+                        }
+                    ],
+                    "order": 36,
+                    "rootField": false,
+                    "restricted": false,
+                    "defaultValue": null
+                },
+                {
+                    "id": null,
+                    "name": "Contents that reuse this content",
+                    "required": null,
+                    "description": "$group $style[hide,use-reference-count]",
+                    "condition": null,
+                    "duplicable": false,
+                    "fields": [
+                        {
+                            "id": null,
+                            "name": "Contents that reuse this content",
+                            "required": null,
+                            "description": "$references(E-learning Contents,Original Content,[view:vContents]) ",
+                            "condition": null,
+                            "duplicable": false,
+                            "fields": [],
+                            "order": 39,
+                            "rootField": false,
+                            "restricted": false,
+                            "defaultValue": null
+                        }
+                    ],
+                    "order": 38,
+                    "rootField": false,
+                    "restricted": false,
+                    "defaultValue": null
+                },
+                {
+                    "id": null,
+                    "name": "Sub Content",
+                    "required": null,
+                    "description": "$references(E-learning Contents,Parent,[view:vContents]) $style[hide-in-new-instance]",
+                    "condition": null,
+                    "duplicable": false,
+                    "fields": [],
+                    "order": 40,
+                    "rootField": false,
+                    "restricted": false,
+                    "defaultValue": null
+                }
+            ],
+            "order": 25,
+            "rootField": true,
+            "restricted": false,
+            "defaultValue": null
+        },
+        {
+            "id": null,
+            "name": "Tasks",
+            "required": null,
+            "description": "$tasks $instanceDescription $groupEdit",
+            "condition": null,
+            "duplicable": false,
+            "fields": [],
+            "order": 41,
+            "rootField": true,
+            "restricted": false,
+            "defaultValue": null
+        },
+        {
+            "id": null,
+            "name": "Proposed Changes",
+            "required": null,
+            "description": "$references(E-learning Content RFCs,Original Content) $style[hide-in-new-instance,hide-in-group-edit]",
+            "condition": null,
+            "duplicable": false,
+            "fields": [],
+            "order": 42,
+            "rootField": true,
+            "restricted": false,
+            "defaultValue": null
+        },
+        {
+            "id": null,
+            "name": "Evaluations",
+            "required": null,
+            "description": "$references(E-learning Content Evaluations,Content) $style[hide-in-new-instance,hide-in-group-edit]",
+            "condition": null,
+            "duplicable": false,
+            "fields": [],
+            "order": 43,
+            "rootField": true,
+            "restricted": false,
+            "defaultValue": null
+        },
+        {
+            "id": null,
+            "name": "Files",
+            "required": null,
+            "description": "$group  $style[hide-in-group-edit]",
+            "condition": null,
+            "duplicable": false,
+            "fields": [
+                {
+                    "id": null,
+                    "name": "File",
+                    "required": null,
+                    "description": "$file",
+                    "condition": null,
+                    "duplicable": true,
+                    "fields": [],
+                    "order": 45,
+                    "rootField": false,
+                    "restricted": false,
+                    "defaultValue": null
+                }
+            ],
+            "order": 44,
+            "rootField": true,
+            "restricted": false,
+            "defaultValue": null
+        }
+    ],
+    "version": null
+}

package/templates/backend/vuepress/others/vuepress/nginx/README.md

@@ -0,0 +1,28 @@
+# Steps to setup the site
+
+1. add the vuepress to the site by linking the nginx configuration file:
+```sh
+ln -s /opt/others/vuepress/nginx/dist/ /usr/share/nginx/html/docs
+```
+
+2. change the following lines in `/etc/nginx/nginx.conf` to make the docs the default content to the site:
+from
+```js
+    location = / {
+        return 302 /recordm/index.html
+    }    
+```
+to
+```js
+    location = / {
+        return 302 /docs/
+    }    
+```
+
+3. restart the nginx service
+```sh
+su -
+systemctl restart nginx.service
+```
+
+4. check that `learning.cultofbits.com` is redirected to the vuepress site and everything is ok