diff --git a/SUMMARY.md b/SUMMARY.md index e0a70e5..0a30e17 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -5,7 +5,7 @@ * [Overview](README.md) * [Functional Capabilities](learn/functional-capabilities.md) * [Technical Architecture](learn/technical-architecture/README.md) - * [Technical Architecture Diagram](learn/technical-architecture/technical-architecture-diagram.md) + * [Technical Architecture Diagram](learn/technical-architecture.md) * [Tech Stack](learn/technical-architecture/tech-stack.md) * [Dependencies](learn/dependencies.md) * [Product Roadmap](learn/product-roadmap.md) @@ -24,168 +24,168 @@ * [Release V 4.9.0](use/release-notes/release-v-4.9.0.md) * [Release V 4.8.0](use/release-notes/release-v-4.8.0-upcoming.md) * [Release V 4.7.0](use/release-notes/release-v-4.7.0-live.md) -* [Developer Guide](use/developer-guide/README.md) - * [USER & ORG SERVICE](use/developer-guide/user-and-org-service/README.md) - * [Features/Core capabilities](use/developer-guide/user-and-org-service/features-core-capabilities.md) - * [Architecture](use/developer-guide/user-and-org-service/architecture/README.md) - * [Code Flow](use/developer-guide/user-and-org-service/architecture/code-flow.md) - * [Data Models](use/developer-guide/user-and-org-service/data-models/README.md) - * [Cassandra](use/developer-guide/user-and-org-service/data-models/cassandra/README.md) - * [Data Dictionary](use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/README.md) - * [User](use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/user.md) - * [Organisation](use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/organisation.md) - * [System Settings](use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/system-settings.md) - * [Role](use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/role.md) - * [Bulk Upload Process](use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/bulk-upload-process.md) - * [Tenant Preference](use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/tenant-preference.md) - * [Cassandra Migration Version](use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/cassandra-migration-version.md) - * [User Consent](use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/user-consent.md) - * [Email Template](use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/email-template.md) - * [OTP](use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/otp.md) - * [Page Management (LMS Service)](use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/page-management-lms-service.md) - * [Location](use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/location.md) - * [User Notes](use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/user-notes.md) - * [Deprecated](use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/deprecated.md) - * [Elastic Search](use/developer-guide/user-and-org-service/data-models/elastic-search.md) - * [Redis](use/developer-guide/user-and-org-service/data-models/redis.md) - * [APIs](use/developer-guide/user-and-org-service/apis/README.md) - * [User Management](use/developer-guide/user-and-org-service/apis/user-management.md) - * [Organisation Management](use/developer-guide/user-and-org-service/apis/organisation-management.md) - * [Location Management](use/developer-guide/user-and-org-service/apis/location-management.md) - * [Consent Management](use/developer-guide/user-and-org-service/apis/consent-management.md) - * [OTP Services](use/developer-guide/user-and-org-service/apis/otp-services.md) - * [Tenant Configurations](use/developer-guide/user-and-org-service/apis/tenant-configurations.md) - * [Bulk Upload](use/developer-guide/user-and-org-service/apis/backend-services.md) - * [System Settings](use/developer-guide/user-and-org-service/apis/system-settings.md) - * [API Management Service](use/developer-guide/user-and-org-service/apis/api-management-service.md) - * [Data Sync](use/developer-guide/user-and-org-service/apis/data-sync.md) - * [Notification APIs](use/developer-guide/user-and-org-service/apis/notification-apis.md) - * [Flink Jobs](use/developer-guide/user-and-org-service/userorg-flink-job/README.md) - * [User Cache Updater](use/developer-guide/user-and-org-service/userorg-flink-job/user-cache-updater.md) - * [Reports](use/developer-guide/user-and-org-service/reports/README.md) - * [Standard Exhaust](use/developer-guide/user-and-org-service/reports/standard-exhaust/README.md) - * [State Admin Geo report](use/developer-guide/user-and-org-service/reports/standard-exhaust/state-admin-geo-report.md) - * [State Admin Report](use/developer-guide/user-and-org-service/reports/standard-exhaust/state-admin-report.md) - * [Other Jobs](use/developer-guide/user-and-org-service/reports/other-jobs/README.md) - * [User Cache Indexer Job](use/developer-guide/user-and-org-service/reports/other-jobs/user-cache-indexer-job.md) - * [Logs, Telemetry Events](use/developer-guide/user-and-org-service/telemetry-events.md) - * [Configuration](use/developer-guide/user-and-org-service/configuration/README.md) - * [Functional Configurations](use/developer-guide/user-and-org-service/configuration/functional-configurations.md) - * [System Settings](use/developer-guide/user-and-org-service/configuration/system-settings.md) - * [Email Configuration](use/developer-guide/user-and-org-service/configuration/email-notification-configuration.md) - * [SMS Configuration](use/developer-guide/user-and-org-service/configuration/sms-configuration.md) - * [OTP based SMS Configuration](use/developer-guide/user-and-org-service/configuration/otp-based-sms-configuration.md) - * [Roles](use/developer-guide/user-and-org-service/roles/README.md) - * [System Roles](use/developer-guide/user-and-org-service/roles/system-roles.md) - * [User Roles](use/developer-guide/user-and-org-service/roles/user-roles.md) - * [RBAC](use/developer-guide/user-and-org-service/roles/rbac.md) - * [Dependencies](use/developer-guide/user-and-org-service/dependencies.md) - * [Keycloak on Sunbird](use/developer-guide/user-and-org-service/keycloak-admin-configuration.md) - * [How to Guide](use/developer-guide/user-and-org-service/how-to-guide/README.md) - * [Create Organization](use/developer-guide/user-and-org-service/how-to-guide/create-organization.md) - * [Create User](use/developer-guide/user-and-org-service/how-to-guide/create-user.md) - * [Add new user type & location](use/developer-guide/user-and-org-service/how-to-guide/add-new-user-type-and-location.md) - * [Single Sign-on with Sunbird](use/developer-guide/user-and-org-service/single-sign-on-with-sunbird.md) - * [Caching and Denormalising User Metadata](use/developer-guide/user-and-org-service/caching-and-denormalising-user-metadata/README.md) - * [ETLUserCacheUpdaterJob](use/developer-guide/user-and-org-service/caching-and-denormalising-user-metadata/etlusercacheupdaterjob.md) - * [UserCacheUpdaterFlinkJob](use/developer-guide/user-and-org-service/caching-and-denormalising-user-metadata/usercacheupdaterflinkjob.md) - * [Unit Tests and Code Coverage](use/developer-guide/user-and-org-service/unit-tests-and-code-coverage.md) - * [FAQs](use/developer-guide/user-and-org-service/faqs.md) - * [LMS(BATCH) SERVICE](use/developer-guide/lms-service/README.md) - * [Features/Core Capabilities](use/developer-guide/lms-service/features-core-capabilities.md) - * [Architecture](use/developer-guide/lms-service/architecture/README.md) - * [Code Flow](use/developer-guide/lms-service/architecture/code-flow.md) - * [Data Models](use/developer-guide/lms-service/data-models/README.md) - * [Cassandra](use/developer-guide/lms-service/data-models/cassandra/README.md) - * [Data Dictionary](use/developer-guide/lms-service/data-models/cassandra/data-dictionary.md) - * [ElasticSearch](use/developer-guide/lms-service/data-models/elasticsearch.md) - * [Redis](use/developer-guide/lms-service/data-models/redis.md) - * [APIs](use/developer-guide/lms-service/apis.md) - * [Flink Jobs](use/developer-guide/lms-service/lms-flink-jobs/README.md) - * [Merge User Courses](use/developer-guide/lms-service/lms-flink-jobs/merge-user-courses.md) - * [Relation Cache Updater](use/developer-guide/lms-service/lms-flink-jobs/relation-cache-updater.md) - * [Activity Aggregate Updater](use/developer-guide/lms-service/lms-flink-jobs/activity-aggregate-updater.md) - * [Assessment Aggregator](use/developer-guide/lms-service/lms-flink-jobs/assessment-aggregator.md) - * [Enrolment Reconciliation](use/developer-guide/lms-service/lms-flink-jobs/enrolment-reconciliation.md) - * [Collection Certificate Pre-Processor](use/developer-guide/lms-service/lms-flink-jobs/collection-certificate-pre-processor.md) - * [Collection Certificate Generator](use/developer-guide/lms-service/lms-flink-jobs/collection-certificate-generator.md) - * [Reports](use/developer-guide/lms-service/reports/README.md) - * [On-Demand Exhaust](use/developer-guide/lms-service/reports/on-demand-exhaust/README.md) - * [Response Exhaust](use/developer-guide/lms-service/reports/on-demand-exhaust/response-exhaust.md) - * [User Info Exhaust](use/developer-guide/lms-service/reports/on-demand-exhaust/user-info-exhaust.md) - * [Progress Exhaust](use/developer-guide/lms-service/reports/on-demand-exhaust/progress-exhaust.md) - * [Other Jobs](use/developer-guide/lms-service/reports/other-jobs/README.md) - * [Collection Summary Job](use/developer-guide/lms-service/reports/other-jobs/collection-summary-job.md) - * [Course Batch Status Updater Job](use/developer-guide/lms-service/reports/other-jobs/course-batch-status-updater-job.md) - * [Cassandra Migrator Job](use/developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job.md) - * [Score Metric Migration Job](use/developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job-1.md) - * [Assessment Score Correction Job](use/developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job-2.md) - * [Collection Reconciliation Job](use/developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job-3.md) - * [Course Enrollment Job](use/developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job-4.md) - * [Course Consumption Job](use/developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job-5.md) - * [Logs, Telemetry Events](use/developer-guide/lms-service/telemetry-events.md) - * [Configuration](use/developer-guide/lms-service/configuration/README.md) - * [System Configuration](use/developer-guide/lms-service/configuration/system-configurations.md) - * [Functional Configuration](use/developer-guide/lms-service/configuration/configurations.md) - * [Dependencies](use/developer-guide/lms-service/dependencies.md) - * [Certificate Registry and Credentialing using Sunbird-RC](use/developer-guide/lms-service/certificate-registry-and-credentialing.md) - * [Certificate Flow](use/developer-guide/lms-service/certificate-flow/README.md) - * [Certificates Creation and Configuration](use/developer-guide/lms-service/certificate-flow/certificates-creation-and-configuration.md) - * [GROUPS](use/developer-guide/groups/README.md) - * [Features/Core Capabilities](use/developer-guide/groups/features-core-capabilities.md) - * [Architecture](use/developer-guide/groups/architecture/README.md) - * [Code Flow](use/developer-guide/groups/architecture/code-flow.md) - * [Data Models](use/developer-guide/groups/data-models/README.md) - * [Cassandra](use/developer-guide/groups/data-models/cassandra/README.md) - * [Data Dictionary](use/developer-guide/groups/data-models/cassandra/data-dictionary.md) - * [Redis](use/developer-guide/groups/data-models/redis.md) - * [APIs](use/developer-guide/groups/apis.md) - * [Logs, Telemetry Events](use/developer-guide/groups/telemetry-events/README.md) - * [UI Telemetry Events](use/developer-guide/groups/telemetry-events/ui-telemetry-events.md) - * [Service Telemetry Events](use/developer-guide/groups/telemetry-events/service-telemetry-events.md) - * [Configuration](use/developer-guide/groups/configuration/README.md) - * [Functional Configurations](use/developer-guide/groups/configuration/functional-configurations.md) - * [Design References](use/developer-guide/groups/design-references.md) - * [Dependencies](use/developer-guide/groups/dependencies.md) - * [Unit Tests and Code Coverage](use/developer-guide/groups/unit-tests-and-code-coverage.md) - * [NOTIFICATION SERVICE](use/developer-guide/notification-service/README.md) - * [Features/Core Capabilities](use/developer-guide/notification-service/features-core-capabilities.md) - * [Architecture](use/developer-guide/notification-service/architecture/README.md) - * [Code Flow](use/developer-guide/notification-service/architecture/code-flow.md) - * [Data Models](use/developer-guide/notification-service/data-models/README.md) - * [Data Dictionary](use/developer-guide/notification-service/data-models/data-dictionary.md) - * [APIs](use/developer-guide/notification-service/apis.md) - * [Flink Jobs](use/developer-guide/notification-service/notification-flink-job.md) - * [Logs, Telemetry Events](use/developer-guide/notification-service/logs-telemetry-events.md) - * [Configuration](use/developer-guide/notification-service/configuration/README.md) - * [Functional Configurations](use/developer-guide/notification-service/configuration/functional-configurations.md) - * [Dependencies](use/developer-guide/notification-service/dependencies.md) - * [Unit Tests and Code Coverage](use/developer-guide/notification-service/unit-tests-and-code-coverage.md) - * [DISCUSSION FORUM](use/developer-guide/discussion-forum/README.md) - * [Features/Core capabilities](use/developer-guide/discussion-forum/features-core-capabilities.md) - * [Architecture](use/developer-guide/discussion-forum/architecture/README.md) - * [Code Flow](use/developer-guide/discussion-forum/architecture/code-flow.md) - * [APIs](use/developer-guide/discussion-forum/apis/README.md) - * [Category APIs](use/developer-guide/discussion-forum/apis/category-apis.md) - * [User APIs](use/developer-guide/discussion-forum/apis/user-apis.md) - * [Post APIs](use/developer-guide/discussion-forum/apis/post-apis.md) - * [Topic APIs](use/developer-guide/discussion-forum/apis/topic-apis.md) - * [Forum APIs](use/developer-guide/discussion-forum/apis/forum-apis.md) - * [Context Schema](use/developer-guide/discussion-forum/context-schema.md) - * [Configurations](use/developer-guide/discussion-forum/configurations/README.md) - * [Nodebb Admin panel settings](use/developer-guide/discussion-forum/configurations/nodebb-admin-panel-settings.md) - * [Discussion MW & Nodebb System Config](use/developer-guide/discussion-forum/configurations/discussion-mw-and-nodebb-system-config.md) - * [Telemetry Events](use/developer-guide/discussion-forum/telemetry-events.md) - * [Dependencies](use/developer-guide/discussion-forum/dependencies.md) - * [DATA PIPELINE (Flink Jobs)](use/developer-guide/data-pipeline-flink-jobs/README.md) - * [Program User Info](use/developer-guide/data-pipeline-flink-jobs/program-flink-job/README.md) - * [Component Diagram](use/developer-guide/data-pipeline-flink-jobs/program-flink-job/component-diagram.md) - * [Data Model](use/developer-guide/data-pipeline-flink-jobs/program-flink-job/data-model.md) - * [Folder Structure](use/developer-guide/data-pipeline-flink-jobs/program-flink-job/folder-structure.md) - * [DATA PRODUCTS](use/developer-guide/data-products/README.md) - * [Program Exhaust](use/developer-guide/data-products/program-exhaust/README.md) - * [Component Diagram](use/developer-guide/data-products/program-exhaust/component-diagram.md) - * [Folder Structure](use/developer-guide/data-products/program-exhaust/folder-structure.md) +* [Developer Guide](learn/product-and-developer-guide/README.md) + * [USER & ORG SERVICE](learn/product-and-developer-guide/user-and-org-service/README.md) + * [Features/Core capabilities](learn/product-and-developer-guide/user-and-org-service/features-core-capabilities.md) + * [Architecture](learn/product-and-developer-guide/user-and-org-service/architecture/README.md) + * [Code Flow](learn/product-and-developer-guide/user-and-org-service/architecture/code-flow.md) + * [Data Models](learn/product-and-developer-guide/user-and-org-service/data-models/README.md) + * [Cassandra](learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/README.md) + * [Data Dictionary](learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/README.md) + * [User](learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/user.md) + * [Organisation](learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/organisation.md) + * [System Settings](learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/system-settings.md) + * [Role](learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/role.md) + * [Bulk Upload Process](learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/bulk-upload-process.md) + * [Tenant Preference](learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/tenant-preference.md) + * [Cassandra Migration Version](learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/cassandra-migration-version.md) + * [User Consent](learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/user-consent.md) + * [Email Template](learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/email-template.md) + * [OTP](learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/otp.md) + * [Page Management (LMS Service)](learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/page-management-lms-service.md) + * [Location](learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/location.md) + * [User Notes](learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/user-notes.md) + * [Deprecated](learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/deprecated.md) + * [Elastic Search](learn/product-and-developer-guide/user-and-org-service/data-models/elastic-search.md) + * [Redis](learn/product-and-developer-guide/user-and-org-service/data-models/redis.md) + * [APIs](learn/product-and-developer-guide/user-and-org-service/apis/README.md) + * [User Management](learn/product-and-developer-guide/user-and-org-service/apis/user-management.md) + * [Organisation Management](learn/product-and-developer-guide/user-and-org-service/apis/organisation-management.md) + * [Location Management](learn/product-and-developer-guide/user-and-org-service/apis/location-management.md) + * [Consent Management](learn/product-and-developer-guide/user-and-org-service/apis/consent-management.md) + * [OTP Services](learn/product-and-developer-guide/user-and-org-service/apis/otp-services.md) + * [Tenant Configurations](learn/product-and-developer-guide/user-and-org-service/apis/tenant-configurations.md) + * [Bulk Upload](learn/product-and-developer-guide/user-and-org-service/apis/backend-services.md) + * [System Settings](learn/product-and-developer-guide/user-and-org-service/apis/system-settings.md) + * [API Management Service](learn/product-and-developer-guide/user-and-org-service/apis/api-management-service.md) + * [Data Sync](learn/product-and-developer-guide/user-and-org-service/apis/data-sync.md) + * [Notification APIs](learn/product-and-developer-guide/user-and-org-service/apis/notification-apis.md) + * [Flink Jobs](learn/product-and-developer-guide/user-and-org-service/userorg-flink-job/README.md) + * [User Cache Updater](learn/product-and-developer-guide/user-and-org-service/userorg-flink-job/userorg-flink-job.md) + * [Reports](learn/product-and-developer-guide/user-and-org-service/reports/README.md) + * [Standard Exhaust](learn/product-and-developer-guide/user-and-org-service/reports/standard-exhaust/README.md) + * [State Admin Geo report](learn/product-and-developer-guide/user-and-org-service/reports/standard-exhaust/state-admin-geo-report.md) + * [State Admin Report](learn/product-and-developer-guide/user-and-org-service/reports/standard-exhaust/state-admin-report.md) + * [Other Jobs](learn/product-and-developer-guide/user-and-org-service/reports/other-jobs/README.md) + * [User Cache Indexer Job](learn/product-and-developer-guide/user-and-org-service/reports/other-jobs/user-cache-indexer-job.md) + * [Logs, Telemetry Events](learn/product-and-developer-guide/user-and-org-service/telemetry-events.md) + * [Configuration](learn/product-and-developer-guide/user-and-org-service/configuration/README.md) + * [Functional Configurations](learn/product-and-developer-guide/user-and-org-service/configuration/functional-configurations.md) + * [System Settings](learn/product-and-developer-guide/user-and-org-service/configuration/system-settings.md) + * [Email Configuration](learn/product-and-developer-guide/user-and-org-service/configuration/email-notification-configuration.md) + * [SMS Configuration](learn/product-and-developer-guide/user-and-org-service/configuration/sms-configuration.md) + * [OTP based SMS Configuration](learn/product-and-developer-guide/user-and-org-service/configuration/otp-based-sms-configuration.md) + * [Roles](learn/product-and-developer-guide/user-and-org-service/roles/README.md) + * [System Roles](learn/product-and-developer-guide/user-and-org-service/roles/system-roles.md) + * [User Roles](learn/product-and-developer-guide/user-and-org-service/roles/user-roles.md) + * [RBAC](learn/product-and-developer-guide/user-and-org-service/roles/rbac.md) + * [Dependencies](learn/product-and-developer-guide/user-and-org-service/dependencies.md) + * [Keycloak on Sunbird](learn/product-and-developer-guide/user-and-org-service/keycloak-admin-configuration.md) + * [How to Guide](learn/product-and-developer-guide/user-and-org-service/how-to-guide/README.md) + * [Create Organization](learn/product-and-developer-guide/user-and-org-service/how-to-guide/create-organization.md) + * [Create User](learn/product-and-developer-guide/user-and-org-service/how-to-guide/create-user.md) + * [Add new user type & location](learn/product-and-developer-guide/user-and-org-service/how-to-guide/add-new-user-type-and-location.md) + * [Single Sign-on with Sunbird](learn/product-and-developer-guide/user-and-org-service/single-sign-on-with-sunbird.md) + * [Caching and Denormalising User Metadata](learn/product-and-developer-guide/user-and-org-service/caching-and-denormalising-user-metadata/README.md) + * [ETLUserCacheUpdaterJob](learn/product-and-developer-guide/user-and-org-service/caching-and-denormalising-user-metadata/etlusercacheupdaterjob.md) + * [UserCacheUpdaterFlinkJob](use/developer-installation/usercacheupdaterflinkjob.md) + * [Unit Tests and Code Coverage](learn/product-and-developer-guide/user-and-org-service/unit-tests-and-code-coverage.md) + * [FAQs](learn/product-and-developer-guide/user-and-org-service/faqs.md) + * [LMS(BATCH) SERVICE](learn/product-and-developer-guide/lms-service/README.md) + * [Features/Core Capabilities](learn/product-and-developer-guide/lms-service/features-core-capabilities.md) + * [Architecture](learn/product-and-developer-guide/lms-service/architecture/README.md) + * [Code Flow](learn/product-and-developer-guide/lms-service/architecture/code-flow.md) + * [Data Models](learn/product-and-developer-guide/lms-service/data-models/README.md) + * [Cassandra](learn/product-and-developer-guide/lms-service/data-models/cassandra/README.md) + * [Data Dictionary](learn/product-and-developer-guide/lms-service/data-models/cassandra/data-dictionary.md) + * [ElasticSearch](learn/product-and-developer-guide/lms-service/data-models/elasticsearch.md) + * [Redis](learn/product-and-developer-guide/lms-service/data-models/redis.md) + * [APIs](learn/product-and-developer-guide/lms-service/apis.md) + * [Flink Jobs](learn/product-and-developer-guide/lms-service/lms-flink-jobs/README.md) + * [Merge User Courses](learn/product-and-developer-guide/lms-service/lms-flink-jobs/merge-user-courses.md) + * [Relation Cache Updater](learn/product-and-developer-guide/lms-service/lms-flink-jobs/relation-cache-updater.md) + * [Activity Aggregate Updater](learn/product-and-developer-guide/lms-service/lms-flink-jobs/activity-aggregate-updater.md) + * [Assessment Aggregator](learn/product-and-developer-guide/lms-service/lms-flink-jobs/assessment-aggregator.md) + * [Enrolment Reconciliation](learn/product-and-developer-guide/lms-service/lms-flink-jobs/enrolment-reconciliation.md) + * [Collection Certificate Pre-Processor](learn/product-and-developer-guide/lms-service/lms-flink-jobs/collection-certificate-pre-processor.md) + * [Collection Certificate Generator](learn/product-and-developer-guide/lms-service/lms-flink-jobs/collection-certificate-generator.md) + * [Reports](learn/product-and-developer-guide/lms-service/reports/README.md) + * [On-Demand Exhaust](learn/product-and-developer-guide/lms-service/reports/on-demand-exhaust/README.md) + * [Response Exhaust](learn/product-and-developer-guide/lms-service/reports/on-demand-exhaust/response-exhaust.md) + * [User Info Exhaust](learn/product-and-developer-guide/lms-service/reports/on-demand-exhaust/user-info-exhaust.md) + * [Progress Exhaust](learn/product-and-developer-guide/lms-service/reports/on-demand-exhaust/progress-exhaust.md) + * [Other Jobs](learn/product-and-developer-guide/lms-service/reports/other-jobs/README.md) + * [Collection Summary Job](learn/product-and-developer-guide/lms-service/reports/other-jobs/collection-summary-job.md) + * [Course Batch Status Updater Job](learn/product-and-developer-guide/lms-service/reports/other-jobs/course-batch-status-updater-job.md) + * [Cassandra Migrator Job](learn/product-and-developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job.md) + * [Score Metric Migration Job](learn/product-and-developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job-1.md) + * [Assessment Score Correction Job](learn/product-and-developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job-2.md) + * [Collection Reconciliation Job](learn/product-and-developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job-3.md) + * [Course Enrollment Job](learn/product-and-developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job-4.md) + * [Course Consumption Job](learn/product-and-developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job-5.md) + * [Logs, Telemetry Events](learn/product-and-developer-guide/lms-service/telemetry-events.md) + * [Configuration](learn/product-and-developer-guide/lms-service/configuration/README.md) + * [System Configuration](learn/product-and-developer-guide/lms-service/configuration/system-configurations.md) + * [Functional Configuration](learn/product-and-developer-guide/lms-service/configuration/configurations.md) + * [Dependencies](learn/product-and-developer-guide/lms-service/dependencies.md) + * [Certificate Registry and Credentialing using Sunbird-RC](learn/product-and-developer-guide/lms-service/certificate-registry-and-credentialing.md) + * [Certificate Flow](learn/product-and-developer-guide/lms-service/certificate-flow/README.md) + * [Certificates Creation and Configuration](learn/product-and-developer-guide/lms-service/certificate-flow/certificates-creation-and-configuration.md) + * [GROUPS](learn/product-and-developer-guide/groups/README.md) + * [Features/Core Capabilities](learn/product-and-developer-guide/groups/features-core-capabilities.md) + * [Architecture](learn/product-and-developer-guide/groups/architecture/README.md) + * [Code Flow](learn/product-and-developer-guide/groups/architecture/code-flow.md) + * [Data Models](learn/product-and-developer-guide/groups/data-models/README.md) + * [Cassandra](learn/product-and-developer-guide/groups/data-models/cassandra/README.md) + * [Data Dictionary](learn/product-and-developer-guide/groups/data-models/cassandra/data-dictionary.md) + * [Redis](learn/product-and-developer-guide/groups/data-models/redis.md) + * [APIs](learn/product-and-developer-guide/groups/apis.md) + * [Logs, Telemetry Events](learn/product-and-developer-guide/groups/telemetry-events/README.md) + * [UI Telemetry Events](learn/product-and-developer-guide/groups/telemetry-events/ui-telemetry-events.md) + * [Service Telemetry Events](learn/product-and-developer-guide/groups/telemetry-events/service-telemetry-events.md) + * [Configuration](learn/product-and-developer-guide/groups/configuration/README.md) + * [Functional Configurations](learn/product-and-developer-guide/groups/configuration/functional-configurations.md) + * [Design References](learn/product-and-developer-guide/groups/design-references.md) + * [Dependencies](learn/product-and-developer-guide/groups/dependencies.md) + * [Unit Tests and Code Coverage](learn/product-and-developer-guide/groups/unit-tests-and-code-coverage.md) + * [NOTIFICATION SERVICE](learn/product-and-developer-guide/notification-service/README.md) + * [Features/Core Capabilities](learn/product-and-developer-guide/notification-service/features-core-capabilities.md) + * [Architecture](learn/product-and-developer-guide/notification-service/architecture/README.md) + * [Code Flow](learn/product-and-developer-guide/notification-service/architecture/code-flow.md) + * [Data Models](learn/product-and-developer-guide/notification-service/data-models/README.md) + * [Data Dictionary](learn/product-and-developer-guide/notification-service/data-models/data-dictionary.md) + * [APIs](learn/product-and-developer-guide/notification-service/apis.md) + * [Flink Jobs](learn/product-and-developer-guide/notification-service/notification-flink-job.md) + * [Logs, Telemetry Events](learn/product-and-developer-guide/notification-service/logs-telemetry-events.md) + * [Configuration](learn/product-and-developer-guide/notification-service/configuration/README.md) + * [Functional Configurations](learn/product-and-developer-guide/notification-service/configuration/functional-configurations.md) + * [Dependencies](learn/product-and-developer-guide/notification-service/dependencies.md) + * [Unit Tests and Code Coverage](learn/product-and-developer-guide/notification-service/unit-tests-and-code-coverage.md) + * [DISCUSSION FORUM](learn/product-and-developer-guide/discussion-forum/README.md) + * [Features/Core capabilities](learn/product-and-developer-guide/discussion-forum/features-core-capabilities.md) + * [Architecture](learn/product-and-developer-guide/discussion-forum/architecture/README.md) + * [Code Flow](learn/product-and-developer-guide/discussion-forum/architecture/code-flow.md) + * [APIs](learn/product-and-developer-guide/discussion-forum/apis/README.md) + * [Category APIs](learn/product-and-developer-guide/discussion-forum/apis/category-apis.md) + * [User APIs](learn/product-and-developer-guide/discussion-forum/apis/user-apis.md) + * [Post APIs](learn/product-and-developer-guide/discussion-forum/apis/post-apis.md) + * [Topic APIs](learn/product-and-developer-guide/discussion-forum/apis/topic-apis.md) + * [Forum APIs](learn/product-and-developer-guide/discussion-forum/apis/forum-apis.md) + * [Context Schema](learn/product-and-developer-guide/discussion-forum/context-schema.md) + * [Configurations](learn/product-and-developer-guide/discussion-forum/configurations/README.md) + * [Nodebb Admin panel settings](learn/product-and-developer-guide/discussion-forum/configurations/nodebb-admin-panel-settings.md) + * [Discussion MW & Nodebb System Config](learn/product-and-developer-guide/discussion-forum/configurations/discussion-mw-and-nodebb-system-config.md) + * [Telemetry Events](learn/product-and-developer-guide/discussion-forum/telemetry-events.md) + * [Dependencies](learn/product-and-developer-guide/discussion-forum/dependencies.md) + * [DATA PIPELINE (Flink Jobs)](learn/product-and-developer-guide/data-pipeline-flink-jobs/README.md) + * [Program User Info](learn/product-and-developer-guide/data-pipeline-flink-jobs/program-flink-job/README.md) + * [Component Diagram](learn/product-and-developer-guide/data-pipeline-flink-jobs/program-flink-job/component-diagram.md) + * [Data Model](learn/product-and-developer-guide/data-pipeline-flink-jobs/program-flink-job/data-model.md) + * [Folder Structure](learn/product-and-developer-guide/data-pipeline-flink-jobs/program-flink-job/folder-structure.md) + * [DATA PRODUCTS](learn/product-and-developer-guide/data-products/README.md) + * [Program Exhaust](learn/product-and-developer-guide/data-products/program-exhaust/README.md) + * [Component Diagram](learn/product-and-developer-guide/data-products/program-exhaust/component-diagram.md) + * [Folder Structure](learn/product-and-developer-guide/data-products/program-exhaust/folder-structure.md) * [Developer Installation](use/developer-installation/README.md) * [USER & ORG SERVICE](use/developer-installation/user-and-org-service/README.md) * [System Requirements](use/developer-installation/user-and-org-service/system-requirements.md) @@ -240,11 +240,11 @@ * [Jenkins Jobs](use/jenkins-jobs.md) * [Release Calendar](use/release-calendar.md) * [Learn More](use/learn-more/README.md) - * [Tech References](use/learn-more/tech-references.md) - * [Telemetry Processing](use/learn-more/telemetry-processing.md) - * [Data Dictionary](use/learn-more/data-dictionary/README.md) - * [Sample Data](use/learn-more/data-dictionary/sample-data.md) -* [FAQs](use/faqs.md) + * [Tech References](learn/tech-references.md) + * [Telemetry Processing](learn/telemetry-processing.md) + * [Data Dictionary](learn/data-dictionary/README.md) + * [Sample Data](learn/data-dictionary/sample-data.md) +* [FAQs](learn/faqs.md) ## Engage diff --git a/use/learn-more/data-dictionary/README.md b/learn/data-dictionary/README.md similarity index 100% rename from use/learn-more/data-dictionary/README.md rename to learn/data-dictionary/README.md diff --git a/use/learn-more/data-dictionary/sample-data.md b/learn/data-dictionary/sample-data.md similarity index 100% rename from use/learn-more/data-dictionary/sample-data.md rename to learn/data-dictionary/sample-data.md diff --git a/use/faqs.md b/learn/faqs.md similarity index 100% rename from use/faqs.md rename to learn/faqs.md diff --git a/learn/functional-capabilities.md b/learn/functional-capabilities.md index cb9dc44..ec92f1a 100644 --- a/learn/functional-capabilities.md +++ b/learn/functional-capabilities.md @@ -6,16 +6,16 @@ description: Functional capabilities enabled by Sunbird Lean These functional capabilities are powered by different Sunbird Lern components - which can be configured by an adopter based on their specific needs. -* **User account creation and management, user login as well as platform administration capabilities** - these are powered by the [`User and Org Service`](../use/developer-guide/user-and-org-service/) component of Sunbird Lern +* **User account creation and management, user login as well as platform administration capabilities** - these are powered by the [`User and Org Service`](product-and-developer-guide/user-and-org-service/) component of Sunbird Lern * Enable users to create accounts to save their platform preferences, access relevant content based on their preferences etc. Users with accounts on the system who login also get access to richer platform features such as Courses and Learner passbook. * Platform administrators can be granted capabilities to manage user roles on the platform, as well as manage platform master data (eg. Location data, Framework values etc.) * Configure the platform to allow for user logins via various mechanisms including username/ password, Google login or single sign-on with other approved systems * **Enable batches of students to take courses on the platform**: Create and manage a course batch - this allows for a cohort of users to take the course within a specified time frame, review user course progress or assessment performance, issue rule based certificates for course completion, merit scores etc. - The [`Batch Service`](../use/developer-guide/lms-service/) component of the Lern Building block is used to power these capabilities within Sunbird Lern. + The [`Batch Service`](product-and-developer-guide/lms-service/) component of the Lern Building block is used to power these capabilities within Sunbird Lern. * **Allow users on the platform to collaborate**: Sunbird Lern components can be configured to give users on the platform collaboration capabilities. These components include the Groups Service as well as Discussion Forums. The functionalities enabled by the Groups component includes the ability for users to create a Group on the platform, add/ remove users from the group, as well as assign activities (content, assessments etc) for the users in the group to undertake. The Group creator is also able to track how much of the activities the users have completed. A Group can also have a Dicussion Forum attached to it, which allows a user to start or contribute to discussions on relevant topics. Such capabilities allow for users to learn together as a cohort, as well as engage in useful collaborative activities to further their learning. - The components used to enable collaboration include [`Groups`](../use/developer-guide/groups/) as well as [`Discussion Forum`](../use/developer-guide/discussion-forum/). -* **Configure the platform to be able to send notifications to users on events of choosing** - these could be user driven or system driven events. This capability is enabled via the [`Notification service`](../use/developer-guide/notification-service/) component. + The components used to enable collaboration include [`Groups`](product-and-developer-guide/groups/) as well as [`Discussion Forum`](product-and-developer-guide/discussion-forum/). +* **Configure the platform to be able to send notifications to users on events of choosing** - these could be user driven or system driven events. This capability is enabled via the [`Notification service`](product-and-developer-guide/notification-service/) component. Various components of Lern permit for different configurations, allowing the system to enable different workflows based on specific requirements. Learn more about the configurations that each component allows for, on the pages for each of the specific components. diff --git a/use/developer-guide/README.md b/learn/product-and-developer-guide/README.md similarity index 99% rename from use/developer-guide/README.md rename to learn/product-and-developer-guide/README.md index 4ef0c2a..cae398d 100644 --- a/use/developer-guide/README.md +++ b/learn/product-and-developer-guide/README.md @@ -1,4 +1,4 @@ -# Product & Developer Guide +# Developer Guide Sunbird Lern enables a host of capabilities that have been utilised by various adopters to create program specific workflows for their users. For instance, [Shikshalokam](https://shikshalokam.org) has created an education leadership platform to train leaders in education - using componets from Sunbird Lern such as the User & Org service as well as the Batch Service. The flexibility of being able to choose the components that are required for the adopter, and the ability to configure them at will (instead of having to build ground up) is what makes it easier to deploy solutions using the Sunbird suite. diff --git a/use/developer-guide/data-pipeline-flink-jobs/README.md b/learn/product-and-developer-guide/data-pipeline-flink-jobs/README.md similarity index 100% rename from use/developer-guide/data-pipeline-flink-jobs/README.md rename to learn/product-and-developer-guide/data-pipeline-flink-jobs/README.md diff --git a/use/developer-guide/data-pipeline-flink-jobs/program-flink-job/README.md b/learn/product-and-developer-guide/data-pipeline-flink-jobs/program-flink-job/README.md similarity index 100% rename from use/developer-guide/data-pipeline-flink-jobs/program-flink-job/README.md rename to learn/product-and-developer-guide/data-pipeline-flink-jobs/program-flink-job/README.md diff --git a/use/developer-guide/data-pipeline-flink-jobs/program-flink-job/component-diagram.md b/learn/product-and-developer-guide/data-pipeline-flink-jobs/program-flink-job/component-diagram.md similarity index 100% rename from use/developer-guide/data-pipeline-flink-jobs/program-flink-job/component-diagram.md rename to learn/product-and-developer-guide/data-pipeline-flink-jobs/program-flink-job/component-diagram.md diff --git a/use/developer-guide/data-pipeline-flink-jobs/program-flink-job/data-model.md b/learn/product-and-developer-guide/data-pipeline-flink-jobs/program-flink-job/data-model.md similarity index 100% rename from use/developer-guide/data-pipeline-flink-jobs/program-flink-job/data-model.md rename to learn/product-and-developer-guide/data-pipeline-flink-jobs/program-flink-job/data-model.md diff --git a/use/developer-guide/data-pipeline-flink-jobs/program-flink-job/folder-structure.md b/learn/product-and-developer-guide/data-pipeline-flink-jobs/program-flink-job/folder-structure.md similarity index 100% rename from use/developer-guide/data-pipeline-flink-jobs/program-flink-job/folder-structure.md rename to learn/product-and-developer-guide/data-pipeline-flink-jobs/program-flink-job/folder-structure.md diff --git a/use/developer-guide/data-products/README.md b/learn/product-and-developer-guide/data-products/README.md similarity index 100% rename from use/developer-guide/data-products/README.md rename to learn/product-and-developer-guide/data-products/README.md diff --git a/use/developer-guide/data-products/program-exhaust/README.md b/learn/product-and-developer-guide/data-products/program-exhaust/README.md similarity index 100% rename from use/developer-guide/data-products/program-exhaust/README.md rename to learn/product-and-developer-guide/data-products/program-exhaust/README.md diff --git a/use/developer-guide/data-products/program-exhaust/component-diagram.md b/learn/product-and-developer-guide/data-products/program-exhaust/component-diagram.md similarity index 100% rename from use/developer-guide/data-products/program-exhaust/component-diagram.md rename to learn/product-and-developer-guide/data-products/program-exhaust/component-diagram.md diff --git a/use/developer-guide/data-products/program-exhaust/folder-structure.md b/learn/product-and-developer-guide/data-products/program-exhaust/folder-structure.md similarity index 100% rename from use/developer-guide/data-products/program-exhaust/folder-structure.md rename to learn/product-and-developer-guide/data-products/program-exhaust/folder-structure.md diff --git a/use/developer-guide/discussion-forum/README.md b/learn/product-and-developer-guide/discussion-forum/README.md similarity index 100% rename from use/developer-guide/discussion-forum/README.md rename to learn/product-and-developer-guide/discussion-forum/README.md diff --git a/use/developer-guide/discussion-forum/apis/README.md b/learn/product-and-developer-guide/discussion-forum/apis/README.md similarity index 89% rename from use/developer-guide/discussion-forum/apis/README.md rename to learn/product-and-developer-guide/discussion-forum/apis/README.md index ee9203d..e81ec3f 100644 --- a/use/developer-guide/discussion-forum/apis/README.md +++ b/learn/product-and-developer-guide/discussion-forum/apis/README.md @@ -1,4 +1,4 @@ -# API Documentation +# APIs You can refer the below API documentation to see all the APIs in discussion forum. diff --git a/use/developer-guide/discussion-forum/apis/category-apis.md b/learn/product-and-developer-guide/discussion-forum/apis/category-apis.md similarity index 100% rename from use/developer-guide/discussion-forum/apis/category-apis.md rename to learn/product-and-developer-guide/discussion-forum/apis/category-apis.md diff --git a/use/developer-guide/discussion-forum/apis/forum-apis.md b/learn/product-and-developer-guide/discussion-forum/apis/forum-apis.md similarity index 100% rename from use/developer-guide/discussion-forum/apis/forum-apis.md rename to learn/product-and-developer-guide/discussion-forum/apis/forum-apis.md diff --git a/use/developer-guide/discussion-forum/apis/post-apis.md b/learn/product-and-developer-guide/discussion-forum/apis/post-apis.md similarity index 100% rename from use/developer-guide/discussion-forum/apis/post-apis.md rename to learn/product-and-developer-guide/discussion-forum/apis/post-apis.md diff --git a/use/developer-guide/discussion-forum/apis/topic-apis.md b/learn/product-and-developer-guide/discussion-forum/apis/topic-apis.md similarity index 100% rename from use/developer-guide/discussion-forum/apis/topic-apis.md rename to learn/product-and-developer-guide/discussion-forum/apis/topic-apis.md diff --git a/use/developer-guide/discussion-forum/apis/user-apis.md b/learn/product-and-developer-guide/discussion-forum/apis/user-apis.md similarity index 100% rename from use/developer-guide/discussion-forum/apis/user-apis.md rename to learn/product-and-developer-guide/discussion-forum/apis/user-apis.md diff --git a/use/developer-guide/discussion-forum/architecture/README.md b/learn/product-and-developer-guide/discussion-forum/architecture/README.md similarity index 100% rename from use/developer-guide/discussion-forum/architecture/README.md rename to learn/product-and-developer-guide/discussion-forum/architecture/README.md diff --git a/use/developer-guide/discussion-forum/architecture/code-flow.md b/learn/product-and-developer-guide/discussion-forum/architecture/code-flow.md similarity index 100% rename from use/developer-guide/discussion-forum/architecture/code-flow.md rename to learn/product-and-developer-guide/discussion-forum/architecture/code-flow.md diff --git a/use/developer-guide/discussion-forum/configurations/README.md b/learn/product-and-developer-guide/discussion-forum/configurations/README.md similarity index 100% rename from use/developer-guide/discussion-forum/configurations/README.md rename to learn/product-and-developer-guide/discussion-forum/configurations/README.md diff --git a/use/developer-guide/discussion-forum/configurations/discussion-mw-and-nodebb-system-config.md b/learn/product-and-developer-guide/discussion-forum/configurations/discussion-mw-and-nodebb-system-config.md similarity index 100% rename from use/developer-guide/discussion-forum/configurations/discussion-mw-and-nodebb-system-config.md rename to learn/product-and-developer-guide/discussion-forum/configurations/discussion-mw-and-nodebb-system-config.md diff --git a/use/developer-guide/discussion-forum/configurations/nodebb-admin-panel-settings.md b/learn/product-and-developer-guide/discussion-forum/configurations/nodebb-admin-panel-settings.md similarity index 100% rename from use/developer-guide/discussion-forum/configurations/nodebb-admin-panel-settings.md rename to learn/product-and-developer-guide/discussion-forum/configurations/nodebb-admin-panel-settings.md diff --git a/use/developer-guide/discussion-forum/context-schema.md b/learn/product-and-developer-guide/discussion-forum/context-schema.md similarity index 100% rename from use/developer-guide/discussion-forum/context-schema.md rename to learn/product-and-developer-guide/discussion-forum/context-schema.md diff --git a/use/developer-guide/discussion-forum/dependencies.md b/learn/product-and-developer-guide/discussion-forum/dependencies.md similarity index 100% rename from use/developer-guide/discussion-forum/dependencies.md rename to learn/product-and-developer-guide/discussion-forum/dependencies.md diff --git a/use/developer-guide/discussion-forum/features-core-capabilities.md b/learn/product-and-developer-guide/discussion-forum/features-core-capabilities.md similarity index 100% rename from use/developer-guide/discussion-forum/features-core-capabilities.md rename to learn/product-and-developer-guide/discussion-forum/features-core-capabilities.md diff --git a/use/developer-guide/discussion-forum/telemetry-events.md b/learn/product-and-developer-guide/discussion-forum/telemetry-events.md similarity index 100% rename from use/developer-guide/discussion-forum/telemetry-events.md rename to learn/product-and-developer-guide/discussion-forum/telemetry-events.md diff --git a/use/developer-guide/groups/README.md b/learn/product-and-developer-guide/groups/README.md similarity index 100% rename from use/developer-guide/groups/README.md rename to learn/product-and-developer-guide/groups/README.md diff --git a/use/developer-guide/groups/apis.md b/learn/product-and-developer-guide/groups/apis.md similarity index 100% rename from use/developer-guide/groups/apis.md rename to learn/product-and-developer-guide/groups/apis.md diff --git a/use/developer-guide/groups/architecture/README.md b/learn/product-and-developer-guide/groups/architecture/README.md similarity index 100% rename from use/developer-guide/groups/architecture/README.md rename to learn/product-and-developer-guide/groups/architecture/README.md diff --git a/use/developer-guide/groups/architecture/code-flow.md b/learn/product-and-developer-guide/groups/architecture/code-flow.md similarity index 100% rename from use/developer-guide/groups/architecture/code-flow.md rename to learn/product-and-developer-guide/groups/architecture/code-flow.md diff --git a/use/developer-guide/groups/configuration/README.md b/learn/product-and-developer-guide/groups/configuration/README.md similarity index 100% rename from use/developer-guide/groups/configuration/README.md rename to learn/product-and-developer-guide/groups/configuration/README.md diff --git a/use/developer-guide/groups/configuration/functional-configurations.md b/learn/product-and-developer-guide/groups/configuration/functional-configurations.md similarity index 100% rename from use/developer-guide/groups/configuration/functional-configurations.md rename to learn/product-and-developer-guide/groups/configuration/functional-configurations.md diff --git a/use/developer-guide/groups/data-models/README.md b/learn/product-and-developer-guide/groups/data-models/README.md similarity index 87% rename from use/developer-guide/groups/data-models/README.md rename to learn/product-and-developer-guide/groups/data-models/README.md index 37b18b6..43cb972 100644 --- a/use/developer-guide/groups/data-models/README.md +++ b/learn/product-and-developer-guide/groups/data-models/README.md @@ -1,4 +1,4 @@ -# Schema +# Data Models Groups service uses Cassandra as the primary data store and Redis for caching the API responses. diff --git a/use/developer-guide/groups/data-models/cassandra/README.md b/learn/product-and-developer-guide/groups/data-models/cassandra/README.md similarity index 100% rename from use/developer-guide/groups/data-models/cassandra/README.md rename to learn/product-and-developer-guide/groups/data-models/cassandra/README.md diff --git a/use/developer-guide/groups/data-models/cassandra/data-dictionary.md b/learn/product-and-developer-guide/groups/data-models/cassandra/data-dictionary.md similarity index 99% rename from use/developer-guide/groups/data-models/cassandra/data-dictionary.md rename to learn/product-and-developer-guide/groups/data-models/cassandra/data-dictionary.md index cf2544d..d2a8c39 100644 --- a/use/developer-guide/groups/data-models/cassandra/data-dictionary.md +++ b/learn/product-and-developer-guide/groups/data-models/cassandra/data-dictionary.md @@ -2,35 +2,16 @@ description: List of tables in Cassandra database used in Groups service --- -# Groups Service - - +# Data Dictionary ### sunbird\_groups.group \[PRIMARY KEY: id] - -
Column NameData TypeDescriptionSample Value
idtextUUID of the groupad2ffd12-ee05-46fc-bbe7-f5a67bd0534e
activitieslist<frozen<map<text, text>>>Activities that are published with in the group[{'id': 'do_2132889347963535361756', 'type': 'Course'}, {'id': 'do_2133016209522933761354', 'type': 'Course'}, {'id': 'do_21333644232679424012289', 'type': 'Course'}, {'id': 'do_21331802990687027216', 'type': 'Course'}, {'id': 'do_2133483390278287361856', 'type': 'Course'}, {'id': 'do_2133817803741347841999', 'type': 'Content Playlist'}, {'id': 'do_213375362019328000129', 'type': 'Teacher Resource'}, {'id': 'do_21333645138176409618', 'type': 'Course'}, {'id': 'do_2132734144209469441409', 'type': 'Course'}, {'id': 'do_2132882557402644481743', 'type': 'Course'}, {'id': 'do_2133187549468098561201', 'type': 'Course'}, {'id': 'do_21334149144616960013071', 'type': 'Course'}]
createdbytextUUID of the group created userfbe926ac-a395-40e4-a65b-9b4f711d7642
createdontimestampGroup created on2021-05-31 11:04:58.580000+0000
descriptiontextDescription of the GroupEditedGroup
membershiptypetextType of member to the group, Possible values: moderated, invite_onlyinvite_only
nametextName of the GroupdashletEditedGroup
statustextStaus of the groupactive
updatedbytextLast updated byfca2925f-1eee-4654-9177-fece3fd6afc9
updatedontimestampLast updated timestamp2021-11-03 04:28:30.528000+0000
- - ### sunbird\_groups.group\_member \[PRIMARY KEY (groupid, userid)] - -
Column NameData TypeDescriptionSample Value
groupidtextUUID, id of the groupad2ffd12-ee05-46fc-bbe7-f5a67bd0534e
useridtextUUID, id of the user7557fd26-5b7c-4dd7-bd60-8e13ac856652
createdbytextUUID, created user idfca2925f-1eee-4654-9177-fece3fd6afc9
createdontimestampCreated on timestamp2021-10-21 14:41:23.654000+0000
removedbytextUUID, of the user that triggered the eventfca2925f-1eee-4654-9177-fece3fd6afc9
removedontimestampremoved timestamp2021-12-03 04:29:09.182000+0000
roletextRole of the person in the group, possible values are: member, adminmember
statustextStatus of the user with respect to the groupactive
updatedbytextUUID, of the last updated userfbe926ac-a395-40e4-a65b-9b4f711d7642
updatedontimestampLast updated timestamp2021-09-08 07:02:12.553000+0000
visitedbooleanMember visited the groupTrue
- - ### sunbird\_groups.user\_group \[PRIMARY KEY: userid] - -
Column NameData TypeDescriptionSample Value
useridtextUUID, id of the user10e2cac0-1757-47d3-a010-b9bca8d2d5d0
groupidset<text>UUID of the groups, groups id's of the user that are linked to{'95cea74a-2647-44a4-98e1-a4337b9e67b2', 'c535cd6a-f03d-4484-9b48-5cce6f935d78'}
- - - - - - - diff --git a/use/developer-guide/groups/data-models/redis.md b/learn/product-and-developer-guide/groups/data-models/redis.md similarity index 100% rename from use/developer-guide/groups/data-models/redis.md rename to learn/product-and-developer-guide/groups/data-models/redis.md diff --git a/use/developer-guide/groups/dependencies.md b/learn/product-and-developer-guide/groups/dependencies.md similarity index 100% rename from use/developer-guide/groups/dependencies.md rename to learn/product-and-developer-guide/groups/dependencies.md diff --git a/use/developer-guide/groups/design-references.md b/learn/product-and-developer-guide/groups/design-references.md similarity index 99% rename from use/developer-guide/groups/design-references.md rename to learn/product-and-developer-guide/groups/design-references.md index c813d1c..9692140 100644 --- a/use/developer-guide/groups/design-references.md +++ b/learn/product-and-developer-guide/groups/design-references.md @@ -1,4 +1,4 @@ -# Design References: +# Design References #### Groups Design diff --git a/use/developer-guide/groups/features-core-capabilities.md b/learn/product-and-developer-guide/groups/features-core-capabilities.md similarity index 100% rename from use/developer-guide/groups/features-core-capabilities.md rename to learn/product-and-developer-guide/groups/features-core-capabilities.md diff --git a/use/developer-guide/groups/telemetry-events/README.md b/learn/product-and-developer-guide/groups/telemetry-events/README.md similarity index 94% rename from use/developer-guide/groups/telemetry-events/README.md rename to learn/product-and-developer-guide/groups/telemetry-events/README.md index 61290ac..c4f892d 100644 --- a/use/developer-guide/groups/telemetry-events/README.md +++ b/learn/product-and-developer-guide/groups/telemetry-events/README.md @@ -1,4 +1,4 @@ -# Logs, Telemetry Events & Configuration +# Logs, Telemetry Events Telemetry is a specification to instrument all the key events. Using this specification reference applications & services will generate telemetry events. For more info refer Sunbird-Telemetry documentation [here](https://telemetry.sunbird.org/). Also to know how telemetry is processed refer to Telemetry Processing Documentation in [https://lern.sunbird.org/learn/telemetry-processing](https://lern.sunbird.org/learn/telemetry-processing). diff --git a/use/developer-guide/groups/telemetry-events/service-telemetry-events.md b/learn/product-and-developer-guide/groups/telemetry-events/service-telemetry-events.md similarity index 100% rename from use/developer-guide/groups/telemetry-events/service-telemetry-events.md rename to learn/product-and-developer-guide/groups/telemetry-events/service-telemetry-events.md diff --git a/use/developer-guide/groups/telemetry-events/ui-telemetry-events.md b/learn/product-and-developer-guide/groups/telemetry-events/ui-telemetry-events.md similarity index 100% rename from use/developer-guide/groups/telemetry-events/ui-telemetry-events.md rename to learn/product-and-developer-guide/groups/telemetry-events/ui-telemetry-events.md diff --git a/use/developer-guide/groups/unit-tests-and-code-coverage.md b/learn/product-and-developer-guide/groups/unit-tests-and-code-coverage.md similarity index 100% rename from use/developer-guide/groups/unit-tests-and-code-coverage.md rename to learn/product-and-developer-guide/groups/unit-tests-and-code-coverage.md diff --git a/use/developer-guide/lms-service/README.md b/learn/product-and-developer-guide/lms-service/README.md similarity index 100% rename from use/developer-guide/lms-service/README.md rename to learn/product-and-developer-guide/lms-service/README.md diff --git a/use/developer-guide/lms-service/apis.md b/learn/product-and-developer-guide/lms-service/apis.md similarity index 100% rename from use/developer-guide/lms-service/apis.md rename to learn/product-and-developer-guide/lms-service/apis.md diff --git a/use/developer-guide/lms-service/architecture/README.md b/learn/product-and-developer-guide/lms-service/architecture/README.md similarity index 100% rename from use/developer-guide/lms-service/architecture/README.md rename to learn/product-and-developer-guide/lms-service/architecture/README.md diff --git a/use/developer-guide/lms-service/architecture/code-flow.md b/learn/product-and-developer-guide/lms-service/architecture/code-flow.md similarity index 100% rename from use/developer-guide/lms-service/architecture/code-flow.md rename to learn/product-and-developer-guide/lms-service/architecture/code-flow.md diff --git a/use/developer-guide/lms-service/certificate-flow/README.md b/learn/product-and-developer-guide/lms-service/certificate-flow/README.md similarity index 100% rename from use/developer-guide/lms-service/certificate-flow/README.md rename to learn/product-and-developer-guide/lms-service/certificate-flow/README.md diff --git a/use/developer-guide/lms-service/certificate-flow/certificates-creation-and-configuration.md b/learn/product-and-developer-guide/lms-service/certificate-flow/certificates-creation-and-configuration.md similarity index 100% rename from use/developer-guide/lms-service/certificate-flow/certificates-creation-and-configuration.md rename to learn/product-and-developer-guide/lms-service/certificate-flow/certificates-creation-and-configuration.md diff --git a/use/developer-guide/lms-service/certificate-registry-and-credentialing.md b/learn/product-and-developer-guide/lms-service/certificate-registry-and-credentialing.md similarity index 96% rename from use/developer-guide/lms-service/certificate-registry-and-credentialing.md rename to learn/product-and-developer-guide/lms-service/certificate-registry-and-credentialing.md index f87b3b2..968c4c7 100644 --- a/use/developer-guide/lms-service/certificate-registry-and-credentialing.md +++ b/learn/product-and-developer-guide/lms-service/certificate-registry-and-credentialing.md @@ -1,4 +1,4 @@ -# Certificate Registry and Credentialing +# Certificate Registry and Credentialing using Sunbird-RC Sunbird-RC is used to provides services to issue digital certificates as per required specifications and enables the storage and verification of digitally issued certificates. diff --git a/use/developer-guide/lms-service/configuration/README.md b/learn/product-and-developer-guide/lms-service/configuration/README.md similarity index 100% rename from use/developer-guide/lms-service/configuration/README.md rename to learn/product-and-developer-guide/lms-service/configuration/README.md diff --git a/use/developer-guide/lms-service/configuration/configurations.md b/learn/product-and-developer-guide/lms-service/configuration/configurations.md similarity index 100% rename from use/developer-guide/lms-service/configuration/configurations.md rename to learn/product-and-developer-guide/lms-service/configuration/configurations.md diff --git a/use/developer-guide/lms-service/configuration/system-configurations.md b/learn/product-and-developer-guide/lms-service/configuration/system-configurations.md similarity index 99% rename from use/developer-guide/lms-service/configuration/system-configurations.md rename to learn/product-and-developer-guide/lms-service/configuration/system-configurations.md index 2a143e0..193eb28 100644 --- a/use/developer-guide/lms-service/configuration/system-configurations.md +++ b/learn/product-and-developer-guide/lms-service/configuration/system-configurations.md @@ -1,4 +1,4 @@ -# System Configurations +# System Configuration diff --git a/use/developer-guide/lms-service/data-models/README.md b/learn/product-and-developer-guide/lms-service/data-models/README.md similarity index 100% rename from use/developer-guide/lms-service/data-models/README.md rename to learn/product-and-developer-guide/lms-service/data-models/README.md diff --git a/use/developer-guide/lms-service/data-models/cassandra/README.md b/learn/product-and-developer-guide/lms-service/data-models/cassandra/README.md similarity index 100% rename from use/developer-guide/lms-service/data-models/cassandra/README.md rename to learn/product-and-developer-guide/lms-service/data-models/cassandra/README.md diff --git a/use/developer-guide/lms-service/data-models/cassandra/data-dictionary.md b/learn/product-and-developer-guide/lms-service/data-models/cassandra/data-dictionary.md similarity index 100% rename from use/developer-guide/lms-service/data-models/cassandra/data-dictionary.md rename to learn/product-and-developer-guide/lms-service/data-models/cassandra/data-dictionary.md diff --git a/use/developer-guide/lms-service/data-models/elasticsearch.md b/learn/product-and-developer-guide/lms-service/data-models/elasticsearch.md similarity index 100% rename from use/developer-guide/lms-service/data-models/elasticsearch.md rename to learn/product-and-developer-guide/lms-service/data-models/elasticsearch.md diff --git a/use/developer-guide/lms-service/data-models/redis.md b/learn/product-and-developer-guide/lms-service/data-models/redis.md similarity index 100% rename from use/developer-guide/lms-service/data-models/redis.md rename to learn/product-and-developer-guide/lms-service/data-models/redis.md diff --git a/use/developer-guide/lms-service/dependencies.md b/learn/product-and-developer-guide/lms-service/dependencies.md similarity index 100% rename from use/developer-guide/lms-service/dependencies.md rename to learn/product-and-developer-guide/lms-service/dependencies.md diff --git a/use/developer-guide/lms-service/features-core-capabilities.md b/learn/product-and-developer-guide/lms-service/features-core-capabilities.md similarity index 100% rename from use/developer-guide/lms-service/features-core-capabilities.md rename to learn/product-and-developer-guide/lms-service/features-core-capabilities.md diff --git a/use/developer-guide/lms-service/lms-flink-jobs/README.md b/learn/product-and-developer-guide/lms-service/lms-flink-jobs/README.md similarity index 100% rename from use/developer-guide/lms-service/lms-flink-jobs/README.md rename to learn/product-and-developer-guide/lms-service/lms-flink-jobs/README.md diff --git a/use/developer-guide/lms-service/lms-flink-jobs/activity-aggregate-updater.md b/learn/product-and-developer-guide/lms-service/lms-flink-jobs/activity-aggregate-updater.md similarity index 100% rename from use/developer-guide/lms-service/lms-flink-jobs/activity-aggregate-updater.md rename to learn/product-and-developer-guide/lms-service/lms-flink-jobs/activity-aggregate-updater.md diff --git a/use/developer-guide/lms-service/lms-flink-jobs/assessment-aggregator.md b/learn/product-and-developer-guide/lms-service/lms-flink-jobs/assessment-aggregator.md similarity index 100% rename from use/developer-guide/lms-service/lms-flink-jobs/assessment-aggregator.md rename to learn/product-and-developer-guide/lms-service/lms-flink-jobs/assessment-aggregator.md diff --git a/use/developer-guide/lms-service/lms-flink-jobs/collection-certificate-generator.md b/learn/product-and-developer-guide/lms-service/lms-flink-jobs/collection-certificate-generator.md similarity index 100% rename from use/developer-guide/lms-service/lms-flink-jobs/collection-certificate-generator.md rename to learn/product-and-developer-guide/lms-service/lms-flink-jobs/collection-certificate-generator.md diff --git a/use/developer-guide/lms-service/lms-flink-jobs/collection-certificate-pre-processor.md b/learn/product-and-developer-guide/lms-service/lms-flink-jobs/collection-certificate-pre-processor.md similarity index 100% rename from use/developer-guide/lms-service/lms-flink-jobs/collection-certificate-pre-processor.md rename to learn/product-and-developer-guide/lms-service/lms-flink-jobs/collection-certificate-pre-processor.md diff --git a/use/developer-guide/lms-service/lms-flink-jobs/enrolment-reconciliation.md b/learn/product-and-developer-guide/lms-service/lms-flink-jobs/enrolment-reconciliation.md similarity index 100% rename from use/developer-guide/lms-service/lms-flink-jobs/enrolment-reconciliation.md rename to learn/product-and-developer-guide/lms-service/lms-flink-jobs/enrolment-reconciliation.md diff --git a/use/developer-guide/lms-service/lms-flink-jobs/merge-user-courses.md b/learn/product-and-developer-guide/lms-service/lms-flink-jobs/merge-user-courses.md similarity index 100% rename from use/developer-guide/lms-service/lms-flink-jobs/merge-user-courses.md rename to learn/product-and-developer-guide/lms-service/lms-flink-jobs/merge-user-courses.md diff --git a/use/developer-guide/lms-service/lms-flink-jobs/relation-cache-updater.md b/learn/product-and-developer-guide/lms-service/lms-flink-jobs/relation-cache-updater.md similarity index 100% rename from use/developer-guide/lms-service/lms-flink-jobs/relation-cache-updater.md rename to learn/product-and-developer-guide/lms-service/lms-flink-jobs/relation-cache-updater.md diff --git a/use/developer-guide/lms-service/reports/README.md b/learn/product-and-developer-guide/lms-service/reports/README.md similarity index 100% rename from use/developer-guide/lms-service/reports/README.md rename to learn/product-and-developer-guide/lms-service/reports/README.md diff --git a/use/developer-guide/lms-service/reports/on-demand-exhaust/README.md b/learn/product-and-developer-guide/lms-service/reports/on-demand-exhaust/README.md similarity index 100% rename from use/developer-guide/lms-service/reports/on-demand-exhaust/README.md rename to learn/product-and-developer-guide/lms-service/reports/on-demand-exhaust/README.md diff --git a/use/developer-guide/lms-service/reports/on-demand-exhaust/progress-exhaust.md b/learn/product-and-developer-guide/lms-service/reports/on-demand-exhaust/progress-exhaust.md similarity index 100% rename from use/developer-guide/lms-service/reports/on-demand-exhaust/progress-exhaust.md rename to learn/product-and-developer-guide/lms-service/reports/on-demand-exhaust/progress-exhaust.md diff --git a/use/developer-guide/lms-service/reports/on-demand-exhaust/response-exhaust.md b/learn/product-and-developer-guide/lms-service/reports/on-demand-exhaust/response-exhaust.md similarity index 100% rename from use/developer-guide/lms-service/reports/on-demand-exhaust/response-exhaust.md rename to learn/product-and-developer-guide/lms-service/reports/on-demand-exhaust/response-exhaust.md diff --git a/use/developer-guide/lms-service/reports/on-demand-exhaust/user-info-exhaust.md b/learn/product-and-developer-guide/lms-service/reports/on-demand-exhaust/user-info-exhaust.md similarity index 100% rename from use/developer-guide/lms-service/reports/on-demand-exhaust/user-info-exhaust.md rename to learn/product-and-developer-guide/lms-service/reports/on-demand-exhaust/user-info-exhaust.md diff --git a/use/developer-guide/lms-service/reports/other-jobs/README.md b/learn/product-and-developer-guide/lms-service/reports/other-jobs/README.md similarity index 100% rename from use/developer-guide/lms-service/reports/other-jobs/README.md rename to learn/product-and-developer-guide/lms-service/reports/other-jobs/README.md diff --git a/use/developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job-1.md b/learn/product-and-developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job-1.md similarity index 92% rename from use/developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job-1.md rename to learn/product-and-developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job-1.md index 44224b9..4d9842d 100644 --- a/use/developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job-1.md +++ b/learn/product-and-developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job-1.md @@ -1,4 +1,4 @@ -# Score metric migration job +# Score Metric Migration Job It helps to update the user activity agg table data with corrected agg\_details and aggregates column. This script is written to update the older records when the agg\_details column was introduced. So that it is a one-time script and it is no longer used. diff --git a/use/developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job-2.md b/learn/product-and-developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job-2.md similarity index 100% rename from use/developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job-2.md rename to learn/product-and-developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job-2.md diff --git a/use/developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job-3.md b/learn/product-and-developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job-3.md similarity index 100% rename from use/developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job-3.md rename to learn/product-and-developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job-3.md diff --git a/use/developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job-4.md b/learn/product-and-developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job-4.md similarity index 100% rename from use/developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job-4.md rename to learn/product-and-developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job-4.md diff --git a/use/developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job-5.md b/learn/product-and-developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job-5.md similarity index 100% rename from use/developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job-5.md rename to learn/product-and-developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job-5.md diff --git a/use/developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job.md b/learn/product-and-developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job.md similarity index 100% rename from use/developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job.md rename to learn/product-and-developer-guide/lms-service/reports/other-jobs/cassandra-migrator-job.md diff --git a/use/developer-guide/lms-service/reports/other-jobs/collection-summary-job.md b/learn/product-and-developer-guide/lms-service/reports/other-jobs/collection-summary-job.md similarity index 100% rename from use/developer-guide/lms-service/reports/other-jobs/collection-summary-job.md rename to learn/product-and-developer-guide/lms-service/reports/other-jobs/collection-summary-job.md diff --git a/use/developer-guide/lms-service/reports/other-jobs/course-batch-status-updater-job.md b/learn/product-and-developer-guide/lms-service/reports/other-jobs/course-batch-status-updater-job.md similarity index 100% rename from use/developer-guide/lms-service/reports/other-jobs/course-batch-status-updater-job.md rename to learn/product-and-developer-guide/lms-service/reports/other-jobs/course-batch-status-updater-job.md diff --git a/use/developer-guide/lms-service/telemetry-events.md b/learn/product-and-developer-guide/lms-service/telemetry-events.md similarity index 98% rename from use/developer-guide/lms-service/telemetry-events.md rename to learn/product-and-developer-guide/lms-service/telemetry-events.md index 9a3ce4b..81aa6fa 100644 --- a/use/developer-guide/lms-service/telemetry-events.md +++ b/learn/product-and-developer-guide/lms-service/telemetry-events.md @@ -1,4 +1,4 @@ -# Logs, Telemetry Events & Configuration +# Logs, Telemetry Events Telemetry is a specification to instrument all the key events. Using this specification reference applications & services will generate telemetry events. For more info refer Sunbird-Telemetry documentation [here](https://telemetry.sunbird.org/). Also to know how telemetry is processed refer to Telemetry Processing Documentation in [https://lern.sunbird.org/learn/telemetry-processing](https://lern.sunbird.org/learn/telemetry-processing). diff --git a/use/developer-guide/notification-service/README.md b/learn/product-and-developer-guide/notification-service/README.md similarity index 100% rename from use/developer-guide/notification-service/README.md rename to learn/product-and-developer-guide/notification-service/README.md diff --git a/use/developer-guide/notification-service/apis.md b/learn/product-and-developer-guide/notification-service/apis.md similarity index 100% rename from use/developer-guide/notification-service/apis.md rename to learn/product-and-developer-guide/notification-service/apis.md diff --git a/use/developer-guide/notification-service/architecture/README.md b/learn/product-and-developer-guide/notification-service/architecture/README.md similarity index 100% rename from use/developer-guide/notification-service/architecture/README.md rename to learn/product-and-developer-guide/notification-service/architecture/README.md diff --git a/use/developer-guide/notification-service/architecture/code-flow.md b/learn/product-and-developer-guide/notification-service/architecture/code-flow.md similarity index 100% rename from use/developer-guide/notification-service/architecture/code-flow.md rename to learn/product-and-developer-guide/notification-service/architecture/code-flow.md diff --git a/use/developer-guide/notification-service/configuration/README.md b/learn/product-and-developer-guide/notification-service/configuration/README.md similarity index 100% rename from use/developer-guide/notification-service/configuration/README.md rename to learn/product-and-developer-guide/notification-service/configuration/README.md diff --git a/use/developer-guide/notification-service/configuration/functional-configurations.md b/learn/product-and-developer-guide/notification-service/configuration/functional-configurations.md similarity index 100% rename from use/developer-guide/notification-service/configuration/functional-configurations.md rename to learn/product-and-developer-guide/notification-service/configuration/functional-configurations.md diff --git a/use/developer-guide/notification-service/data-models/README.md b/learn/product-and-developer-guide/notification-service/data-models/README.md similarity index 100% rename from use/developer-guide/notification-service/data-models/README.md rename to learn/product-and-developer-guide/notification-service/data-models/README.md diff --git a/use/developer-guide/notification-service/data-models/data-dictionary.md b/learn/product-and-developer-guide/notification-service/data-models/data-dictionary.md similarity index 99% rename from use/developer-guide/notification-service/data-models/data-dictionary.md rename to learn/product-and-developer-guide/notification-service/data-models/data-dictionary.md index 9e4be82..408c286 100644 --- a/use/developer-guide/notification-service/data-models/data-dictionary.md +++ b/learn/product-and-developer-guide/notification-service/data-models/data-dictionary.md @@ -2,7 +2,7 @@ description: List of tables in Cassandra database used in Notification service --- -# Notification Service +# Data Dictionary diff --git a/use/developer-guide/notification-service/dependencies.md b/learn/product-and-developer-guide/notification-service/dependencies.md similarity index 100% rename from use/developer-guide/notification-service/dependencies.md rename to learn/product-and-developer-guide/notification-service/dependencies.md diff --git a/use/developer-guide/notification-service/features-core-capabilities.md b/learn/product-and-developer-guide/notification-service/features-core-capabilities.md similarity index 100% rename from use/developer-guide/notification-service/features-core-capabilities.md rename to learn/product-and-developer-guide/notification-service/features-core-capabilities.md diff --git a/use/developer-guide/notification-service/logs-telemetry-events.md b/learn/product-and-developer-guide/notification-service/logs-telemetry-events.md similarity index 99% rename from use/developer-guide/notification-service/logs-telemetry-events.md rename to learn/product-and-developer-guide/notification-service/logs-telemetry-events.md index 639ad05..9613750 100644 --- a/use/developer-guide/notification-service/logs-telemetry-events.md +++ b/learn/product-and-developer-guide/notification-service/logs-telemetry-events.md @@ -1,4 +1,4 @@ -# Logs, Telemetry Events & Configuration +# Logs, Telemetry Events Telemetry is a specification to instrument all the key events. Using this specification reference applications & services will generate telemetry events. For more info refer Sunbird-Telemetry documentation [here](https://telemetry.sunbird.org/). Also to know how telemetry is processed refer to Telemetry Processing Documentation in [https://lern.sunbird.org/learn/telemetry-processing](https://lern.sunbird.org/learn/telemetry-processing). diff --git a/use/developer-guide/notification-service/notification-flink-job.md b/learn/product-and-developer-guide/notification-service/notification-flink-job.md similarity index 100% rename from use/developer-guide/notification-service/notification-flink-job.md rename to learn/product-and-developer-guide/notification-service/notification-flink-job.md diff --git a/use/developer-guide/notification-service/unit-tests-and-code-coverage.md b/learn/product-and-developer-guide/notification-service/unit-tests-and-code-coverage.md similarity index 100% rename from use/developer-guide/notification-service/unit-tests-and-code-coverage.md rename to learn/product-and-developer-guide/notification-service/unit-tests-and-code-coverage.md diff --git a/use/developer-guide/user-and-org-service/README.md b/learn/product-and-developer-guide/user-and-org-service/README.md similarity index 100% rename from use/developer-guide/user-and-org-service/README.md rename to learn/product-and-developer-guide/user-and-org-service/README.md diff --git a/use/developer-guide/user-and-org-service/apis/README.md b/learn/product-and-developer-guide/user-and-org-service/apis/README.md similarity index 99% rename from use/developer-guide/user-and-org-service/apis/README.md rename to learn/product-and-developer-guide/user-and-org-service/apis/README.md index 6baf55d..9b3163a 100644 --- a/use/developer-guide/user-and-org-service/apis/README.md +++ b/learn/product-and-developer-guide/user-and-org-service/apis/README.md @@ -1,7 +1,9 @@ -# API Documentation +# APIs The **UserOrg microservice** provides services to enable and manage the lifecycle, administration, and permissions of users; registries of users, organisations, and geographic locations; to send user notifications through multiple channels such as email, SMS, and OTPs. The APIs are grouped as: + + | Feature | API Documentation | | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | User Management (CRUD) | http://docs.sunbird.org/latest/apis/userapi/ | diff --git a/use/developer-guide/user-and-org-service/apis/api-management-service.md b/learn/product-and-developer-guide/user-and-org-service/apis/api-management-service.md similarity index 100% rename from use/developer-guide/user-and-org-service/apis/api-management-service.md rename to learn/product-and-developer-guide/user-and-org-service/apis/api-management-service.md diff --git a/use/developer-guide/user-and-org-service/apis/backend-services.md b/learn/product-and-developer-guide/user-and-org-service/apis/backend-services.md similarity index 97% rename from use/developer-guide/user-and-org-service/apis/backend-services.md rename to learn/product-and-developer-guide/user-and-org-service/apis/backend-services.md index 4ded28c..2c72e4a 100644 --- a/use/developer-guide/user-and-org-service/apis/backend-services.md +++ b/learn/product-and-developer-guide/user-and-org-service/apis/backend-services.md @@ -1,4 +1,4 @@ -# Backend Services +# Bulk Upload {% swagger src="../../../../.gitbook/assets/BulkUploadServices.yaml" path="/user/v1/upload" method="post" %} [BulkUploadServices.yaml](../../../../.gitbook/assets/BulkUploadServices.yaml) diff --git a/use/developer-guide/user-and-org-service/apis/consent-management.md b/learn/product-and-developer-guide/user-and-org-service/apis/consent-management.md similarity index 100% rename from use/developer-guide/user-and-org-service/apis/consent-management.md rename to learn/product-and-developer-guide/user-and-org-service/apis/consent-management.md diff --git a/use/developer-guide/user-and-org-service/apis/data-sync.md b/learn/product-and-developer-guide/user-and-org-service/apis/data-sync.md similarity index 100% rename from use/developer-guide/user-and-org-service/apis/data-sync.md rename to learn/product-and-developer-guide/user-and-org-service/apis/data-sync.md diff --git a/use/developer-guide/user-and-org-service/apis/location-management.md b/learn/product-and-developer-guide/user-and-org-service/apis/location-management.md similarity index 100% rename from use/developer-guide/user-and-org-service/apis/location-management.md rename to learn/product-and-developer-guide/user-and-org-service/apis/location-management.md diff --git a/use/developer-guide/user-and-org-service/apis/notification-apis.md b/learn/product-and-developer-guide/user-and-org-service/apis/notification-apis.md similarity index 100% rename from use/developer-guide/user-and-org-service/apis/notification-apis.md rename to learn/product-and-developer-guide/user-and-org-service/apis/notification-apis.md diff --git a/use/developer-guide/user-and-org-service/apis/organisation-management.md b/learn/product-and-developer-guide/user-and-org-service/apis/organisation-management.md similarity index 100% rename from use/developer-guide/user-and-org-service/apis/organisation-management.md rename to learn/product-and-developer-guide/user-and-org-service/apis/organisation-management.md diff --git a/use/developer-guide/user-and-org-service/apis/otp-services.md b/learn/product-and-developer-guide/user-and-org-service/apis/otp-services.md similarity index 100% rename from use/developer-guide/user-and-org-service/apis/otp-services.md rename to learn/product-and-developer-guide/user-and-org-service/apis/otp-services.md diff --git a/use/developer-guide/user-and-org-service/apis/system-settings.md b/learn/product-and-developer-guide/user-and-org-service/apis/system-settings.md similarity index 100% rename from use/developer-guide/user-and-org-service/apis/system-settings.md rename to learn/product-and-developer-guide/user-and-org-service/apis/system-settings.md diff --git a/use/developer-guide/user-and-org-service/apis/tenant-configurations.md b/learn/product-and-developer-guide/user-and-org-service/apis/tenant-configurations.md similarity index 100% rename from use/developer-guide/user-and-org-service/apis/tenant-configurations.md rename to learn/product-and-developer-guide/user-and-org-service/apis/tenant-configurations.md diff --git a/use/developer-guide/user-and-org-service/apis/user-management.md b/learn/product-and-developer-guide/user-and-org-service/apis/user-management.md similarity index 100% rename from use/developer-guide/user-and-org-service/apis/user-management.md rename to learn/product-and-developer-guide/user-and-org-service/apis/user-management.md diff --git a/use/developer-guide/user-and-org-service/architecture/README.md b/learn/product-and-developer-guide/user-and-org-service/architecture/README.md similarity index 100% rename from use/developer-guide/user-and-org-service/architecture/README.md rename to learn/product-and-developer-guide/user-and-org-service/architecture/README.md diff --git a/use/developer-guide/user-and-org-service/architecture/code-flow.md b/learn/product-and-developer-guide/user-and-org-service/architecture/code-flow.md similarity index 100% rename from use/developer-guide/user-and-org-service/architecture/code-flow.md rename to learn/product-and-developer-guide/user-and-org-service/architecture/code-flow.md diff --git a/use/developer-guide/user-and-org-service/caching-and-denormalising-user-metadata/README.md b/learn/product-and-developer-guide/user-and-org-service/caching-and-denormalising-user-metadata/README.md similarity index 100% rename from use/developer-guide/user-and-org-service/caching-and-denormalising-user-metadata/README.md rename to learn/product-and-developer-guide/user-and-org-service/caching-and-denormalising-user-metadata/README.md diff --git a/use/developer-guide/user-and-org-service/caching-and-denormalising-user-metadata/etlusercacheupdaterjob.md b/learn/product-and-developer-guide/user-and-org-service/caching-and-denormalising-user-metadata/etlusercacheupdaterjob.md similarity index 100% rename from use/developer-guide/user-and-org-service/caching-and-denormalising-user-metadata/etlusercacheupdaterjob.md rename to learn/product-and-developer-guide/user-and-org-service/caching-and-denormalising-user-metadata/etlusercacheupdaterjob.md diff --git a/use/developer-guide/user-and-org-service/configuration/README.md b/learn/product-and-developer-guide/user-and-org-service/configuration/README.md similarity index 100% rename from use/developer-guide/user-and-org-service/configuration/README.md rename to learn/product-and-developer-guide/user-and-org-service/configuration/README.md diff --git a/use/developer-guide/user-and-org-service/configuration/email-notification-configuration.md b/learn/product-and-developer-guide/user-and-org-service/configuration/email-notification-configuration.md similarity index 100% rename from use/developer-guide/user-and-org-service/configuration/email-notification-configuration.md rename to learn/product-and-developer-guide/user-and-org-service/configuration/email-notification-configuration.md diff --git a/use/developer-guide/user-and-org-service/configuration/functional-configurations.md b/learn/product-and-developer-guide/user-and-org-service/configuration/functional-configurations.md similarity index 100% rename from use/developer-guide/user-and-org-service/configuration/functional-configurations.md rename to learn/product-and-developer-guide/user-and-org-service/configuration/functional-configurations.md diff --git a/use/developer-guide/user-and-org-service/configuration/otp-based-sms-configuration.md b/learn/product-and-developer-guide/user-and-org-service/configuration/otp-based-sms-configuration.md similarity index 100% rename from use/developer-guide/user-and-org-service/configuration/otp-based-sms-configuration.md rename to learn/product-and-developer-guide/user-and-org-service/configuration/otp-based-sms-configuration.md diff --git a/use/developer-guide/user-and-org-service/configuration/sms-configuration.md b/learn/product-and-developer-guide/user-and-org-service/configuration/sms-configuration.md similarity index 99% rename from use/developer-guide/user-and-org-service/configuration/sms-configuration.md rename to learn/product-and-developer-guide/user-and-org-service/configuration/sms-configuration.md index e85e713..6aa098f 100644 --- a/use/developer-guide/user-and-org-service/configuration/sms-configuration.md +++ b/learn/product-and-developer-guide/user-and-org-service/configuration/sms-configuration.md @@ -1,4 +1,4 @@ -# SMS Configurations +# SMS Configuration Create an account on [msg91](https://msg91.com/in) and login to get the [authKey](https://msg91.com/help/MSG91/where-can-i-find-my-authentication-key). Register the sender ID. Register the SMS template in the DLT portal and get a template ID. Add the approved template to the msg91 portal along with the template ID. diff --git a/use/developer-guide/user-and-org-service/configuration/system-settings.md b/learn/product-and-developer-guide/user-and-org-service/configuration/system-settings.md similarity index 100% rename from use/developer-guide/user-and-org-service/configuration/system-settings.md rename to learn/product-and-developer-guide/user-and-org-service/configuration/system-settings.md diff --git a/use/developer-guide/user-and-org-service/data-models/README.md b/learn/product-and-developer-guide/user-and-org-service/data-models/README.md similarity index 100% rename from use/developer-guide/user-and-org-service/data-models/README.md rename to learn/product-and-developer-guide/user-and-org-service/data-models/README.md diff --git a/use/developer-guide/user-and-org-service/data-models/cassandra/README.md b/learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/README.md similarity index 100% rename from use/developer-guide/user-and-org-service/data-models/cassandra/README.md rename to learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/README.md diff --git a/use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/README.md b/learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/README.md similarity index 97% rename from use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/README.md rename to learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/README.md index e8f4950..8b37739 100644 --- a/use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/README.md +++ b/learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/README.md @@ -2,7 +2,7 @@ description: List of tables in Cassandra database used in User-Org service --- -# User-Org Service +# Data Dictionary ### Table List: diff --git a/use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/bulk-upload-process.md b/learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/bulk-upload-process.md similarity index 100% rename from use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/bulk-upload-process.md rename to learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/bulk-upload-process.md diff --git a/use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/cassandra-migration-version.md b/learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/cassandra-migration-version.md similarity index 100% rename from use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/cassandra-migration-version.md rename to learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/cassandra-migration-version.md diff --git a/use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/deprecated.md b/learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/deprecated.md similarity index 100% rename from use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/deprecated.md rename to learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/deprecated.md diff --git a/use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/email-template.md b/learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/email-template.md similarity index 100% rename from use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/email-template.md rename to learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/email-template.md diff --git a/use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/location.md b/learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/location.md similarity index 100% rename from use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/location.md rename to learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/location.md diff --git a/use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/organisation.md b/learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/organisation.md similarity index 100% rename from use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/organisation.md rename to learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/organisation.md diff --git a/use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/otp.md b/learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/otp.md similarity index 100% rename from use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/otp.md rename to learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/otp.md diff --git a/use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/page-management-lms-service.md b/learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/page-management-lms-service.md similarity index 100% rename from use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/page-management-lms-service.md rename to learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/page-management-lms-service.md diff --git a/use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/role.md b/learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/role.md similarity index 100% rename from use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/role.md rename to learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/role.md diff --git a/use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/system-settings.md b/learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/system-settings.md similarity index 100% rename from use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/system-settings.md rename to learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/system-settings.md diff --git a/use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/tenant-preference.md b/learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/tenant-preference.md similarity index 100% rename from use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/tenant-preference.md rename to learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/tenant-preference.md diff --git a/use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/user-consent.md b/learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/user-consent.md similarity index 100% rename from use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/user-consent.md rename to learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/user-consent.md diff --git a/use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/user-notes.md b/learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/user-notes.md similarity index 100% rename from use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/user-notes.md rename to learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/user-notes.md diff --git a/use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/user.md b/learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/user.md similarity index 100% rename from use/developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/user.md rename to learn/product-and-developer-guide/user-and-org-service/data-models/cassandra/data-dictionary/user.md diff --git a/use/developer-guide/user-and-org-service/data-models/elastic-search.md b/learn/product-and-developer-guide/user-and-org-service/data-models/elastic-search.md similarity index 100% rename from use/developer-guide/user-and-org-service/data-models/elastic-search.md rename to learn/product-and-developer-guide/user-and-org-service/data-models/elastic-search.md diff --git a/use/developer-guide/user-and-org-service/data-models/redis.md b/learn/product-and-developer-guide/user-and-org-service/data-models/redis.md similarity index 100% rename from use/developer-guide/user-and-org-service/data-models/redis.md rename to learn/product-and-developer-guide/user-and-org-service/data-models/redis.md diff --git a/use/developer-guide/user-and-org-service/dependencies.md b/learn/product-and-developer-guide/user-and-org-service/dependencies.md similarity index 100% rename from use/developer-guide/user-and-org-service/dependencies.md rename to learn/product-and-developer-guide/user-and-org-service/dependencies.md diff --git a/use/developer-guide/user-and-org-service/faqs.md b/learn/product-and-developer-guide/user-and-org-service/faqs.md similarity index 100% rename from use/developer-guide/user-and-org-service/faqs.md rename to learn/product-and-developer-guide/user-and-org-service/faqs.md diff --git a/use/developer-guide/user-and-org-service/features-core-capabilities.md b/learn/product-and-developer-guide/user-and-org-service/features-core-capabilities.md similarity index 100% rename from use/developer-guide/user-and-org-service/features-core-capabilities.md rename to learn/product-and-developer-guide/user-and-org-service/features-core-capabilities.md diff --git a/use/developer-guide/user-and-org-service/how-to-guide/README.md b/learn/product-and-developer-guide/user-and-org-service/how-to-guide/README.md similarity index 100% rename from use/developer-guide/user-and-org-service/how-to-guide/README.md rename to learn/product-and-developer-guide/user-and-org-service/how-to-guide/README.md diff --git a/use/developer-guide/user-and-org-service/how-to-guide/add-new-user-type-and-location.md b/learn/product-and-developer-guide/user-and-org-service/how-to-guide/add-new-user-type-and-location.md similarity index 99% rename from use/developer-guide/user-and-org-service/how-to-guide/add-new-user-type-and-location.md rename to learn/product-and-developer-guide/user-and-org-service/how-to-guide/add-new-user-type-and-location.md index c113b68..146c53a 100644 --- a/use/developer-guide/user-and-org-service/how-to-guide/add-new-user-type-and-location.md +++ b/learn/product-and-developer-guide/user-and-org-service/how-to-guide/add-new-user-type-and-location.md @@ -13,7 +13,7 @@ User-Type and Sub-Types breif info\ {% endembed %} -{% file src="../../../.gitbook/assets/UserTypes-SB.pdf" %} +{% file src="../../../../.gitbook/assets/UserTypes-SB.pdf" %} Configure user-type and location {% endfile %} diff --git a/use/developer-guide/user-and-org-service/how-to-guide/create-organization.md b/learn/product-and-developer-guide/user-and-org-service/how-to-guide/create-organization.md similarity index 100% rename from use/developer-guide/user-and-org-service/how-to-guide/create-organization.md rename to learn/product-and-developer-guide/user-and-org-service/how-to-guide/create-organization.md diff --git a/use/developer-guide/user-and-org-service/how-to-guide/create-user.md b/learn/product-and-developer-guide/user-and-org-service/how-to-guide/create-user.md similarity index 100% rename from use/developer-guide/user-and-org-service/how-to-guide/create-user.md rename to learn/product-and-developer-guide/user-and-org-service/how-to-guide/create-user.md diff --git a/use/developer-guide/user-and-org-service/keycloak-admin-configuration.md b/learn/product-and-developer-guide/user-and-org-service/keycloak-admin-configuration.md similarity index 100% rename from use/developer-guide/user-and-org-service/keycloak-admin-configuration.md rename to learn/product-and-developer-guide/user-and-org-service/keycloak-admin-configuration.md diff --git a/use/developer-guide/user-and-org-service/reports/README.md b/learn/product-and-developer-guide/user-and-org-service/reports/README.md similarity index 100% rename from use/developer-guide/user-and-org-service/reports/README.md rename to learn/product-and-developer-guide/user-and-org-service/reports/README.md diff --git a/use/developer-guide/user-and-org-service/reports/other-jobs/README.md b/learn/product-and-developer-guide/user-and-org-service/reports/other-jobs/README.md similarity index 100% rename from use/developer-guide/user-and-org-service/reports/other-jobs/README.md rename to learn/product-and-developer-guide/user-and-org-service/reports/other-jobs/README.md diff --git a/use/developer-guide/user-and-org-service/reports/other-jobs/user-cache-indexer-job.md b/learn/product-and-developer-guide/user-and-org-service/reports/other-jobs/user-cache-indexer-job.md similarity index 76% rename from use/developer-guide/user-and-org-service/reports/other-jobs/user-cache-indexer-job.md rename to learn/product-and-developer-guide/user-and-org-service/reports/other-jobs/user-cache-indexer-job.md index 3097f5b..677e2d1 100644 --- a/use/developer-guide/user-and-org-service/reports/other-jobs/user-cache-indexer-job.md +++ b/learn/product-and-developer-guide/user-and-org-service/reports/other-jobs/user-cache-indexer-job.md @@ -19,8 +19,8 @@ The User Cache Indexer job reads user data from Cassandra, performs transformati For more information please visit,\ -{% content-ref url="../../caching-and-denormalising-user-metadata/usercacheupdaterflinkjob.md" %} -[usercacheupdaterflinkjob.md](../../caching-and-denormalising-user-metadata/usercacheupdaterflinkjob.md) +{% content-ref url="../../../../../use/developer-installation/usercacheupdaterflinkjob.md" %} +[usercacheupdaterflinkjob.md](../../../../../use/developer-installation/usercacheupdaterflinkjob.md) {% endcontent-ref %} {% content-ref url="../../caching-and-denormalising-user-metadata/etlusercacheupdaterjob.md" %} diff --git a/use/developer-guide/user-and-org-service/reports/standard-exhaust/README.md b/learn/product-and-developer-guide/user-and-org-service/reports/standard-exhaust/README.md similarity index 100% rename from use/developer-guide/user-and-org-service/reports/standard-exhaust/README.md rename to learn/product-and-developer-guide/user-and-org-service/reports/standard-exhaust/README.md diff --git a/use/developer-guide/user-and-org-service/reports/standard-exhaust/state-admin-geo-report.md b/learn/product-and-developer-guide/user-and-org-service/reports/standard-exhaust/state-admin-geo-report.md similarity index 100% rename from use/developer-guide/user-and-org-service/reports/standard-exhaust/state-admin-geo-report.md rename to learn/product-and-developer-guide/user-and-org-service/reports/standard-exhaust/state-admin-geo-report.md diff --git a/use/developer-guide/user-and-org-service/reports/standard-exhaust/state-admin-report.md b/learn/product-and-developer-guide/user-and-org-service/reports/standard-exhaust/state-admin-report.md similarity index 100% rename from use/developer-guide/user-and-org-service/reports/standard-exhaust/state-admin-report.md rename to learn/product-and-developer-guide/user-and-org-service/reports/standard-exhaust/state-admin-report.md diff --git a/use/developer-guide/user-and-org-service/roles/README.md b/learn/product-and-developer-guide/user-and-org-service/roles/README.md similarity index 100% rename from use/developer-guide/user-and-org-service/roles/README.md rename to learn/product-and-developer-guide/user-and-org-service/roles/README.md diff --git a/use/developer-guide/user-and-org-service/roles/rbac.md b/learn/product-and-developer-guide/user-and-org-service/roles/rbac.md similarity index 100% rename from use/developer-guide/user-and-org-service/roles/rbac.md rename to learn/product-and-developer-guide/user-and-org-service/roles/rbac.md diff --git a/use/developer-guide/user-and-org-service/roles/system-roles.md b/learn/product-and-developer-guide/user-and-org-service/roles/system-roles.md similarity index 100% rename from use/developer-guide/user-and-org-service/roles/system-roles.md rename to learn/product-and-developer-guide/user-and-org-service/roles/system-roles.md diff --git a/use/developer-guide/user-and-org-service/roles/user-roles.md b/learn/product-and-developer-guide/user-and-org-service/roles/user-roles.md similarity index 93% rename from use/developer-guide/user-and-org-service/roles/user-roles.md rename to learn/product-and-developer-guide/user-and-org-service/roles/user-roles.md index b994221..b1cb6a1 100644 --- a/use/developer-guide/user-and-org-service/roles/user-roles.md +++ b/learn/product-and-developer-guide/user-and-org-service/roles/user-roles.md @@ -5,7 +5,8 @@ How to assign roles to a user? Below APIs can be used to assign roles: ([API Documentation](https://lern.sunbird.org/learn/product-and-developer-guide/user-and-org-service/api-documentation/user-management)) 
POST /v2/user/assign/role
-POST /private/user/v2/assign/role
+POST /private/user/v2/assign/role + User with ORG\_ADMIN role only can assign other roles in the specific org to a user. User need not belong to the specific org to have a role of that org. Admin can choose users in other org also. diff --git a/use/developer-guide/user-and-org-service/single-sign-on-with-sunbird.md b/learn/product-and-developer-guide/user-and-org-service/single-sign-on-with-sunbird.md similarity index 100% rename from use/developer-guide/user-and-org-service/single-sign-on-with-sunbird.md rename to learn/product-and-developer-guide/user-and-org-service/single-sign-on-with-sunbird.md diff --git a/use/developer-guide/user-and-org-service/telemetry-events.md b/learn/product-and-developer-guide/user-and-org-service/telemetry-events.md similarity index 99% rename from use/developer-guide/user-and-org-service/telemetry-events.md rename to learn/product-and-developer-guide/user-and-org-service/telemetry-events.md index 126b75d..3c7a4a5 100644 --- a/use/developer-guide/user-and-org-service/telemetry-events.md +++ b/learn/product-and-developer-guide/user-and-org-service/telemetry-events.md @@ -1,4 +1,4 @@ -# Logs, Telemetry Events & Configuration +# Logs, Telemetry Events Telemetry is a specification to instrument all the key events. Using this specification reference applications & services will generate telemetry events. For more info refer Sunbird-Telemetry documentation [here](https://telemetry.sunbird.org/). Also to know how telemetry is processed refer to Telemetry Processing Documentation in [https://lern.sunbird.org/learn/telemetry-processing](https://lern.sunbird.org/learn/telemetry-processing). diff --git a/use/developer-guide/user-and-org-service/unit-tests-and-code-coverage.md b/learn/product-and-developer-guide/user-and-org-service/unit-tests-and-code-coverage.md similarity index 100% rename from use/developer-guide/user-and-org-service/unit-tests-and-code-coverage.md rename to learn/product-and-developer-guide/user-and-org-service/unit-tests-and-code-coverage.md diff --git a/use/developer-guide/user-and-org-service/userorg-flink-job/README.md b/learn/product-and-developer-guide/user-and-org-service/userorg-flink-job/README.md similarity index 100% rename from use/developer-guide/user-and-org-service/userorg-flink-job/README.md rename to learn/product-and-developer-guide/user-and-org-service/userorg-flink-job/README.md diff --git a/use/developer-guide/user-and-org-service/userorg-flink-job/user-cache-updater.md b/learn/product-and-developer-guide/user-and-org-service/userorg-flink-job/userorg-flink-job.md similarity index 100% rename from use/developer-guide/user-and-org-service/userorg-flink-job/user-cache-updater.md rename to learn/product-and-developer-guide/user-and-org-service/userorg-flink-job/userorg-flink-job.md diff --git a/use/learn-more/tech-references.md b/learn/tech-references.md similarity index 100% rename from use/learn-more/tech-references.md rename to learn/tech-references.md diff --git a/learn/technical-architecture/technical-architecture-diagram.md b/learn/technical-architecture.md similarity index 85% rename from learn/technical-architecture/technical-architecture-diagram.md rename to learn/technical-architecture.md index f4d695c..dee76e6 100644 --- a/learn/technical-architecture/technical-architecture-diagram.md +++ b/learn/technical-architecture.md @@ -12,7 +12,7 @@
-

Lern Technical Architecture

+

Lern Technical Architecture

@@ -28,7 +28,7 @@ The diagram represents the components involved and their arrangement in **Lern**
-

Data-Product Architecture

+

Data-Product Architecture

@@ -36,6 +36,6 @@ Reports (Data products) refer to products or services derived from data analysis
-
+
diff --git a/use/learn-more/telemetry-processing.md b/learn/telemetry-processing.md similarity index 85% rename from use/learn-more/telemetry-processing.md rename to learn/telemetry-processing.md index f7b1a6c..6745a2a 100644 --- a/use/learn-more/telemetry-processing.md +++ b/learn/telemetry-processing.md @@ -10,4 +10,4 @@ Data-pipeline Flow Diagram: Lern services like UserOrg, LMS, Groups and Notification Service push the telemetry to Raw Kafka in below diagram, so telemetry extractor flink job and ingest router flink job does not come in to action. Those two jobs are application in case of UI components, where telemetry service API is called to push telemetry events. -
+
diff --git a/use/developer-installation/discussion-forum/installation-guide/README.md b/use/developer-installation/discussion-forum/installation-guide/README.md index 5cd03b4..de3d5de 100644 --- a/use/developer-installation/discussion-forum/installation-guide/README.md +++ b/use/developer-installation/discussion-forum/installation-guide/README.md @@ -1,3 +1,3 @@ # Installation Guide -Refer to [configurations](../../../developer-guide/discussion-forum/configurations/ "mention") +Refer to [configurations](../../../../learn/product-and-developer-guide/discussion-forum/configurations/ "mention") diff --git a/use/developer-installation/notification-service/installation-configuration.md b/use/developer-installation/notification-service/installation-configuration.md index 46d2bbc..00b78c1 100644 --- a/use/developer-installation/notification-service/installation-configuration.md +++ b/use/developer-installation/notification-service/installation-configuration.md @@ -60,14 +60,14 @@ LEARNER_SERVICE_PORT= ### SMS Config -{% content-ref url="../../developer-guide/user-and-org-service/configuration/sms-configuration.md" %} -[sms-configuration.md](../../developer-guide/user-and-org-service/configuration/sms-configuration.md) +{% content-ref url="../../../learn/product-and-developer-guide/user-and-org-service/configuration/sms-configuration.md" %} +[sms-configuration.md](../../../learn/product-and-developer-guide/user-and-org-service/configuration/sms-configuration.md) {% endcontent-ref %} ### Email Config -{% content-ref url="../../developer-guide/user-and-org-service/configuration/email-notification-configuration.md" %} -[email-notification-configuration.md](../../developer-guide/user-and-org-service/configuration/email-notification-configuration.md) +{% content-ref url="../../../learn/product-and-developer-guide/user-and-org-service/configuration/email-notification-configuration.md" %} +[email-notification-configuration.md](../../../learn/product-and-developer-guide/user-and-org-service/configuration/email-notification-configuration.md) {% endcontent-ref %} ### Other Config diff --git a/use/developer-guide/user-and-org-service/caching-and-denormalising-user-metadata/usercacheupdaterflinkjob.md b/use/developer-installation/usercacheupdaterflinkjob.md similarity index 98% rename from use/developer-guide/user-and-org-service/caching-and-denormalising-user-metadata/usercacheupdaterflinkjob.md rename to use/developer-installation/usercacheupdaterflinkjob.md index d8e5cc1..2edb4d8 100644 --- a/use/developer-guide/user-and-org-service/caching-and-denormalising-user-metadata/usercacheupdaterflinkjob.md +++ b/use/developer-installation/usercacheupdaterflinkjob.md @@ -11,7 +11,7 @@ Reference Wiki Links: **Implementation Design:** -
usercacheupdaterflinkdesign
+
usercacheupdaterflinkdesign
![](blob:https://project-sunbird.atlassian.net/4576cfc6-d4bf-4cad-b0a5-b217e77358ed#media-blob-url=true\&id=2da0751c-f2f3-4ec6-9a84-917fce115f47\&collection=contentId-1520074753\&contextId=1520074753\&height=551\&width=501\&alt=)Design for the fields to be fetched: diff --git a/use/release-notes/release-v-5.3.0.md b/use/release-notes/release-v-5.3.0.md index d7fcbe3..be35348 100644 --- a/use/release-notes/release-v-5.3.0.md +++ b/use/release-notes/release-v-5.3.0.md @@ -7,7 +7,7 @@ | Batch Service | Build/Core/Lms | [`release-5.3.2_RC2`](https://github.com/Sunbird-Lern/lms-service/tree/release-5.3.1\_RC2) | Deploy/Kubernetes/Lms | [release-5.3.0-lern](https://github.com/project-sunbird/sunbird-devops/tree/release-5.3.0-lern) | CSP related changes | | User\&Org Service | Build/Core/Learner | [release-5.3.1\_RC1](https://github.com/Sunbird-Lern/userorg-service/tree/release-5.3.1\_RC1) | Deploy/Kubernetes/Learner | [release-5.3.0-lern](https://github.com/project-sunbird/sunbird-devops/tree/release-5.3.0-lern) | CSP related changes | | Data pipeline | Build/Lern/FlinkJobs | [release-5.3.1\_RC1](https://github.com/Sunbird-Lern/data-pipeline/tree/release-5.3.1\_RC1) | Deploy/Lern/FlinkJobs | [release-5.3.1\_RC1](https://github.com/Sunbird-Lern/data-pipeline/tree/release-5.3.1\_RC1) | CSP related changes | -| Data Products | Build/Lern/LernDataProducts | [release-5.3.1\_RC1](https://github.com/Sunbird-Lern/data-products/tree/release-5.3.1\_RC1) | Deploy/Lern/LernDataProducts | [release-5.3.1\_RC1](https://github.com/Sunbird-Lern/data-products/tree/release-5.3.1\_RC1) | CSP related changes | +| Data Products | Build/Lern/LernDataProducts | [release-5.3.1\_RC2](https://github.com/Sunbird-Lern/data-products/tree/release-5.3.1\_RC2) | Deploy/Lern/LernDataProducts | [release-5.3.1\_RC2](https://github.com/Sunbird-Lern/data-products/tree/release-5.3.1\_RC2) | CSP related changes | **Jenkins Configurations for csp support:**