GITBOOK-870: change request with no subject merged in GitBook

SUMMARY.md

@@ -126,40 +126,40 @@
 
 ## Contribute
 
-* [Extend / Contribute to Sunbird](contribute/extend-contribute-to-sunbird.md)
-* [System Requirements](contribute/system-requirements/README.md)
-  * [Learning Apps](contribute/system-requirements/learning-apps.md)
-* [Source Code](contribute/source-code/README.md)
-  * [Architecture -  Component Diagram](contribute/source-code/architecture-component-diagram.md)
-  * [Developer Guide](contribute/source-code/workflows/README.md)
-    * [Portal](contribute/source-code/workflows/portal/README.md)
-      * [Component Diagram](contribute/source-code/workflows/portal/component-diagram.md)
-    * [Mobile](contribute/source-code/workflows/mobile/README.md)
-      * [Component Diagram](contribute/source-code/workflows/mobile/component-diagram.md)
-      * [sunbird-mobile-sdk](contribute/source-code/workflows/mobile/sunbird-mobile-sdk.md)
-      * [Sunbird-mobile-app plugins](contribute/source-code/workflows/mobile/sunbird-mobile-app-plugins.md)
-      * [Configurations to setup mobile app](contribute/source-code/workflows/mobile/configurations-to-setup-mobile-app.md)
-    * [Form service](contribute/source-code/workflows/form-service/README.md)
-      * [Architecture](contribute/source-code/workflows/form-service/architecture.md)
-      * [Data model](contribute/source-code/workflows/form-service/data-model.md)
-      * [API's](contribute/source-code/workflows/form-service/apis.md)
-  * [Reference Apps](contribute/source-code/reference-apps.md)
-  * [Platform](contribute/source-code/platform.md)
-* [Install Locally](contribute/install-locally/README.md)
-  * [SunbirdED Mobile](contribute/install-locally/sunbirded-mobile.md)
-  * [SunbirdED Portal](contribute/install-locally/sunbirded-portal.md)
-* [Configuration](contribute/configuration/README.md)
-  * [SunbirdEd Portal](contribute/configuration/sunbirded-portal.md)
-  * [Sunbird Mobile](contribute/configuration/sunbird-mobile.md)
-* [Independent Libraries](contribute/independent-libraries/README.md)
-  * [Common Consumption Components](contribute/independent-libraries/common-consumption-components.md)
-  * [SunbirdEd Forms](contribute/independent-libraries/sunbirded-forms.md)
-  * [Sunbird Client Services](contribute/independent-libraries/sunbird-client-services.md)
-  * [Sunbird Styles](contribute/independent-libraries/sunbird-styles.md)
-  * [Sunbird Themes](contribute/independent-libraries/sunbird-themes.md)
-  * [Sunbird Tag Manager](contribute/independent-libraries/sunbird-tag-manager.md)
-* [Issue tracker/ Create Issue](contribute/issue-tracker.md)
-* [Contribute to ED](contribute/contribute-to-ed.md)
+* [Extend / Contribute to Sunbird](use-1/extend-contribute-to-sunbird.md)
+* [System Requirements](use-1/system-requirements/README.md)
+  * [Learning Apps](use-1/system-requirements/learning-apps.md)
+* [Source Code](use-1/source-code/README.md)
+  * [Architecture -  Component Diagram](use-1/source-code/sunbird-ed-architecture.md)
+  * [Developer Guide](use-1/source-code/workflows/README.md)
+    * [Portal](use-1/source-code/workflows/portal/README.md)
+      * [Component Diagram](use-1/source-code/workflows/portal-component-diagrams.md)
+    * [Mobile](use-1/source-code/workflows/mobile/README.md)
+      * [Component Diagram](use-1/source-code/workflows/mobile-component-diagrams.md)
+      * [sunbird-mobile-sdk](use-1/source-code/workflows/mobile/sunbird-mobile-sdk.md)
+      * [Sunbird-mobile-app plugins](development-resources/misc-pages/sunbird-mobile-app-plugins.md)
+      * [Configurations to setup mobile app](use-1/source-code/workflows/mobile/configurations-to-setup-mobile-app.md)
+    * [Form service](use-1/source-code/workflows/form-service/README.md)
+      * [Architecture](use-1/source-code/workflows/form-service/architecture.md)
+      * [Data model](use-1/source-code/workflows/form-service/data-model.md)
+      * [API's](use-1/source-code/workflows/form-service/apis.md)
+  * [Reference Apps](use-1/source-code/reference-apps.md)
+  * [Platform](use-1/source-code/platform.md)
+* [Install Locally](use-1/install-locally/README.md)
+  * [SunbirdED Mobile](use-1/install-locally/sunbirded-mobile.md)
+  * [SunbirdED Portal](use-1/install-locally/sunbirded-portal.md)
+* [Configuration](use-1/configuration/README.md)
+  * [SunbirdEd Portal](use-1/configuration/sunbirded-portal.md)
+  * [Sunbird Mobile](use-1/configuration/sunbird-mobile.md)
+* [Independent Libraries](use-1/independent-libraries/README.md)
+  * [Common Consumption Components](use-1/independent-libraries/common-consumption-components.md)
+  * [SunbirdEd Forms](use-1/independent-libraries/sunbirded-forms.md)
+  * [Sunbird Client Services](use-1/independent-libraries/sunbird-client-services.md)
+  * [Sunbird Styles](use-1/independent-libraries/sunbird-styles.md)
+  * [Sunbird Themes](use-1/independent-libraries/sunbird-themes.md)
+  * [Sunbird Tag Manager](use-1/independent-libraries/sunbird-tag-manager.md)
+* [Issue tracker/ Create Issue](use-1/issue-tracker.md)
+* [Contribute to ED](use-1/contribute-to-ed.md)
 
 ## Misc
 

learn/technical-architecture/technical-architecture-diagram.md

@@ -6,4 +6,4 @@
 
 ##  **Component view diagram**
 
-[architecture-component-diagram.md](../../contribute/source-code/architecture-component-diagram.md "mention")
+[sunbird-ed-architecture.md](../../use-1/source-code/sunbird-ed-architecture.md "mention")

contribute/extend-contribute-to-sunbird.md → use-1/extend-contribute-to-sunbird.md

@@ -2,7 +2,7 @@
 
 **Contribution process**
 
-****[**https://sunbird.gitbook.io/sunbird-community-practices/VJZlxBFjATn5Y97QSiJB/**](https://sunbird.gitbook.io/sunbird-community-practices/VJZlxBFjATn5Y97QSiJB/)****
+[**https://sunbird.gitbook.io/sunbird-community-practices/VJZlxBFjATn5Y97QSiJB/**](https://sunbird.gitbook.io/sunbird-community-practices/VJZlxBFjATn5Y97QSiJB/)
 
 **Priority definition**
 

contribute/issue-tracker.md → use-1/issue-tracker.md

@@ -1,3 +1,3 @@
-# Issue tracker
+# Issue tracker/ Create Issue
 
 Link to issues in Issue tracker - [Link](https://project-sunbird.atlassian.net/jira/software/c/projects/ED/issues/?jql=project%20%3D%20%22ED%22%20AND%20type%20in%20standardIssueTypes\(\)%20ORDER%20BY%20created%20DESC)

contribute/source-code/architecture-component-diagram.md → use-1/source-code/sunbird-ed-architecture.md

@@ -1,4 +1,4 @@
-# Sunbird-ED Architecture
+# Architecture -  Component Diagram
 
 ## Architecuture
 

use-1/source-code/workflows/README.md

@@ -0,0 +1,2 @@
+# Developer Guide
+

use-1/source-code/workflows/form-service/README.md

@@ -0,0 +1,6 @@
+# Form service
+
+{% embed url="https://github.com/project-sunbird/sunbird-ext-framework" %}
+
+
+

use-1/source-code/workflows/form-service/apis.md

@@ -0,0 +1,26 @@
+---
+description: Sample API Reference for Form Service Used  in ED Portal
+---
+
+# API's
+
+
+
+## Sunbird-Forms
+
+This service is owned by Sunbird-ED Building Block. The CRUD API's are documented as part of the below API collection.
+
+What properties can be used as part of forum create & the details has updated in the below document itself.
+
+{% embed url="https://documenter.getpostman.com/view/25186239/2s93Y2TNAw" %}
+
+## **Sunbird ED Portal Postman Forms Config Documentation**
+
+This Postman Forms collection details about 
+
+* Configuring forms for the functional features used in the portal
+* The documentation of usage of each form API's in the portal.
+* Functional form configs with Sample Create and Read API's.
+*  Mandatory and Non-mandatory forms with impact.
+
+{% embed url="https://documenter.getpostman.com/view/25186239/2s946pXoZ2" %}

use-1/source-code/workflows/form-service/architecture.md

@@ -0,0 +1,44 @@
+# Architecture
+
+<figure><img src="../../../../.gitbook/assets/Screenshot 2023-08-09 at 3.11.47 PM.png" alt=""><figcaption><p>Form Service Architecture</p></figcaption></figure>
+
+## From Service
+
+It's an extensible framework library to create a server side API endpoint.&#x20;
+
+### [EXT Framework Server](https://github.com/project-sunbird/sunbird-ext-framework/blob/master/server/README.md#plugin-lifecycle)
+
+During this phase, the framework tries to read the manifest.ts file under the plugin's home directory.&#x20;
+
+When it finds the manifest.ts file, it will register the plugin in the "plugin registry" and update the status of the plugin as REGISTERED.
+
+The framework tries to locate if any schema files are defined in the manifest.ts file. If the plugin has not defined any schema file, the framework would skip this step.
+
+If there are schema files, then it would try to create a schema(tables/index) on the corresponding database provided based on the schema definition
+
+### [Framework API /Route](https://github.com/project-sunbird/sunbird-ext-framework/blob/master/demo/plugins/FormService/server/routes.ts)
+
+During this phase, the framework tries to find `routes.ts` files under the plugin home directory. If the file is not found, the plugin fails to load.&#x20;
+
+The file should export a class named `Router`. The framework registers the routes(endpoint) defined for the plugin with the "prefix" defined in the `manifest.ts` file.
+
+### [Request Validator](https://github.com/project-sunbird/sunbird-ext-framework/blob/master/demo/plugins/FormService/server/RequestValidator/index.ts)
+
+During this phase, the framework will validate the request body that is requested by the client app. If the request doesn't have mandatory data or valid input it will throw the error in response.
+
+### [Server Method](https://github.com/project-sunbird/sunbird-ext-framework/blob/master/demo/plugins/FormService/server/server.ts)
+
+During this phase, the method retrieves data from a Cassandra database based on the provided query parameters.&#x20;
+
+It tries to find a matching record by gradually relaxing the constraints on the properties. Once a record is found or all attempts are exhausted, the retrieved data is processed and sent back as a response.
+
+
+
+
+
+
+
+
+
+###
+

use-1/source-code/workflows/form-service/data-model.md

@@ -0,0 +1,24 @@
+---
+description: Cassandra database used in Form service
+---
+
+# Data model
+
+
+
+| Column Name        | Data Type | Description                                                      | Sample Data                                                                                                                                                                                |
+| ------------------ | --------- | ---------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| id                 | string    | Represents an API uniquely                                       | api.form.create                                                                                                                                                                            |
+| ver                | string    | Represents the version of the API which was used                 | 1.0                                                                                                                                                                                        |
+| ts                 | integer   | Represents the EPOCH (UTC) timestamp in milliseconds since EPOCH | 2023-04-13T11:04:52.333Z                                                                                                                                                                   |
+| params             | object    |                                                                  | <p>{</p><p>        "resmsgid": "bb6c9650-5a04-44e8-9077-452ef7aa5cdf",</p><p>        "msgid": "6f64bd31-cf55-4f80-9f13-d19a799fe6fa",</p><p>        "status": "successful"</p><p>    }</p> |
+| msgid              | string    | Represents the unique ID of the message being sent               | 6f64bd31-cf55-4f80-9f13-d19a799fe6fa                                                                                                                                                       |
+| did                | string    | Represents the device UUID from which API is called              | bb6c9650-5a04-44e8-9077-452ef7aa5cdf                                                                                                                                                       |
+| type\*             | varchar   | Represents the type of form being created                        | content, user, forum, app, program-dashboard, config                                                                                                                                       |
+| subtype\*          | varchar   | Represents the sub-category of form being created                | course, collection, textbook, resource, login                                                                                                                                              |
+| action\*           | varchar   | Represents the user action on the form                           | ilter, create, get, save, review , search                                                                                                                                                  |
+| component\*        | varchar   | Represents the consumption platform for the form                 | portal, mobile                                                                                                                                                                             |
+| root\_org          | varchar   | Represents the form accesabilty to all (\*) or specific          | \*, 123213232332323                                                                                                                                                                        |
+| framework          | varchar   | Represents the form accesabilty to all (\*) or specific          | \*, 121324324274724                                                                                                                                                                        |
+| created\_on        | timestamp | created time                                                     | 2023-04-13T11:08:21.260Z                                                                                                                                                                   |
+| last\_modified\_on | timestamp | modified time                                                    | 2023-04-13T12:35:52.143Z                                                                                                                                                                   |

contribute/source-code/workflows/mobile/component-diagram.md → use-1/source-code/workflows/mobile-component-diagrams.md

@@ -11,13 +11,13 @@ description: >-
 
 ## Architecture
 
-<figure><img src="../../../../.gitbook/assets/ed5e8b16-36e7-4738-baa6-3118cb5c6f2c.png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../.gitbook/assets/ed5e8b16-36e7-4738-baa6-3118cb5c6f2c.png" alt=""><figcaption></figcaption></figure>
 
 ## [Source Code](https://github.com/Sunbird-Ed/SunbirdEd-mobile-app/tree/master)
 
 Sunbird Mobiles app follows a basic angular / Ionic code structure. The top level of the workspace contains workspace-wide configuration files, configuration files for the application, and test files.
 
-<figure><img src="../../../../.gitbook/assets/Screenshot 2023-08-04 at 1.18.12 AM.png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../.gitbook/assets/Screenshot 2023-08-04 at 1.18.12 AM.png" alt=""><figcaption></figcaption></figure>
 
 \
 All following primary folders are highlighted in the above screenshot
@@ -32,7 +32,7 @@ All following primary folders are highlighted in the above screenshot
 
 **plugins** folder contains all the plugins which provide JavaScript interface to native components (Android/ Ios)required by Sunbird Mobile App. They allow the app to use native device capabilities beyond what is available to pure web components.
 
-[List of plugins used in the Sunbird Mobile app](sunbird-mobile-app-plugins.md)
+[List of plugins used in the Sunbird Mobile app](../../../development-resources/misc-pages/sunbird-mobile-app-plugins.md)
 
 ### app
 
@@ -42,7 +42,7 @@ This folder contains all the modules and components. It contains the Sunbird Mob
 
 As Modules are a great way to organize an application and extend it with capabilities from external libraries so, in the Sunbird-mobile-app, each functionality/page is configured as a Module. Some key modules are given in the below diagram.
 
-<figure><img src="../../../../.gitbook/assets/Screenshot 2023-08-04 at 2.59.34 PM.png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../.gitbook/assets/Screenshot 2023-08-04 at 2.59.34 PM.png" alt=""><figcaption></figcaption></figure>
 
 * [home](https://sunbird-ed.github.io/docs/mobile/modules/HomePageModule.html)
 * [qrcoderesult](https://sunbird-ed.github.io/docs/mobile/modules/QrcoderesultPageModule.html)
@@ -98,18 +98,18 @@ This folder contains classes with the @injectible decorator. This decorator tell
 
 sunbird-mobile-sdk is the heart of Sunbird-mobile-app which contains all the business logic starting from API access to offline data management.
 
-<figure><img src="../../../../.gitbook/assets/Screenshot 2023-08-06 at 2.14.42 AM.png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../.gitbook/assets/Screenshot 2023-08-06 at 2.14.42 AM.png" alt=""><figcaption></figcaption></figure>
 
 ### Configurations required to  setup Sunbird-mobile-app
 
 These are the set of files required  to set up Sunbird-mobile-app
 
-* [sunbird.properties](configurations-to-setup-mobile-app.md#1.-sunbird.properties)
-* [google-service.json](configurations-to-setup-mobile-app.md#2.-google-service.json)
+* [sunbird.properties](mobile/configurations-to-setup-mobile-app.md#1.-sunbird.properties)
+* [google-service.json](mobile/configurations-to-setup-mobile-app.md#2.-google-service.json)
 
 ### Forms required to  initialize Sunbird-mobile-app
 
 The Form Configurations are a set of predefined forms that enable users to easily modify the UI without changing anything in the source code. Also, it allows users to quickly update any type of app attribute even if the app is already available in Play Store/app store without any app update.
 
-[List of forms available in Sunbird-Mobile-app](../../../../development-resources/misc-pages/mobile-form-configurations.md)
+[List of forms available in Sunbird-Mobile-app](../../../development-resources/misc-pages/mobile-form-configurations.md)