diff --git a/src/docusaurus/docs/aboutorganizationadministrator.mdx b/src/docusaurus/docs/aboutorganizationadministrator.mdx index ae20443..c22709a 100644 --- a/src/docusaurus/docs/aboutorganizationadministrator.mdx +++ b/src/docusaurus/docs/aboutorganizationadministrator.mdx @@ -31,9 +31,9 @@ After receiving the application's link, you must sign up to create an account. To log out, do one of the following actions: -* Select Logout from the Application menu. +* On desktop: Select Logout from the left panel. -* Go to the Application menu and select Logout. +* On mobile: Tap the icon and select Logout. diff --git a/src/docusaurus/docs/aboutsessionmanager.mdx b/src/docusaurus/docs/aboutsessionmanager.mdx index b39dbda..0953492 100644 --- a/src/docusaurus/docs/aboutsessionmanager.mdx +++ b/src/docusaurus/docs/aboutsessionmanager.mdx @@ -1,5 +1,7 @@ import SignUp from './_signup.mdx'; import Admonition from '@theme/Admonition'; +import BurgerMenu from './media/burgermenu-icon.png' + # Session Manager @@ -33,7 +35,8 @@ After receiving the application's link, you must sign up to create an account. To log out, do one of the following actions: -* Select Logout from the Application menu. +* On desktop: Select Logout from the left panel. + +* On mobile: Tap the icon and select Logout. -* Go to the Application menu ![burger menu](media/burgermenu-icon.png) and select Logout. diff --git a/src/docusaurus/docs/accountloginactivity.mdx b/src/docusaurus/docs/accountloginactivity.mdx index 2a05b08..a6a10c7 100644 --- a/src/docusaurus/docs/accountloginactivity.mdx +++ b/src/docusaurus/docs/accountloginactivity.mdx @@ -16,8 +16,8 @@ On the Login activity page, you can view the following: To access the Login activity page, do one of the following actions: - * Select Login activity from the Application menu. - * Go to the Application menu and select Login activity. + * On desktop: Select Login activity from the left panel. + * On mobile: Tap the icon and select Login activity. ![](media/loginactivity.png) diff --git a/src/docusaurus/docs/bulkupload.mdx b/src/docusaurus/docs/bulkupload.mdx index 94252e5..4e5d0a2 100644 --- a/src/docusaurus/docs/bulkupload.mdx +++ b/src/docusaurus/docs/bulkupload.mdx @@ -1,4 +1,5 @@ import Admonition from '@theme/Admonition'; +import BurgerMenu from './media/burgermenu-icon.png' # Uploading Users to the Application @@ -17,8 +18,11 @@ Using a CSV file, organization administrators can upload the list of users to th **To upload users to the application, do as follows:** 1. Do one of the following actions: - * Select **Workspace** from the **Application** menu. - * Go to the **Application** menu ![burger menu](media/burgermenu-icon.png) and select **Workspace**. + + * On desktop: Select Workspace from the left panel. + + * On mobile: Tap the icon and select Workspace. + 2. On the Workspace page, click **Manage user**. diff --git a/src/docusaurus/docs/change-language.mdx b/src/docusaurus/docs/change-language.mdx index ab1ca42..ea474e0 100644 --- a/src/docusaurus/docs/change-language.mdx +++ b/src/docusaurus/docs/change-language.mdx @@ -8,11 +8,15 @@ You can use the application in a language of your choice. **To change the language settings, do as follows:** -
    -
  1. Go to the Application menu
    and select Language.
    2. -
  2. On the Language page, click a Language button of your choice.
    3. +1. * On desktop: Select Language from the left panel. + + * On mobile: Tap the icon and select Language. + +2. On the Language page, click a Language button of your choice. +

    -
  3. Click Submit. The text on the application user interface now appears in the language that you have chosen.
    4. -
\ No newline at end of file + +3. Click Submit. The text on the application user interface now appears in the language that you have chosen. + diff --git a/src/docusaurus/docs/changepassword.mdx b/src/docusaurus/docs/changepassword.mdx index 901b2a3..574ae55 100644 --- a/src/docusaurus/docs/changepassword.mdx +++ b/src/docusaurus/docs/changepassword.mdx @@ -18,8 +18,8 @@ For a secure account, you can change your existing password if: 1. Do one of the following actions: - * Select Change password from the Application menu. - * Go to the Application menu and select Change password. + * On desktop: Select Change password from the left panel. + * On mobile: Tap the icon and select Change password. 2. Enter your old password and the new password. diff --git a/src/docusaurus/docs/createsession-sessionmanager.mdx b/src/docusaurus/docs/createsession-sessionmanager.mdx index c9fe6f1..ef5b6e0 100644 --- a/src/docusaurus/docs/createsession-sessionmanager.mdx +++ b/src/docusaurus/docs/createsession-sessionmanager.mdx @@ -2,6 +2,8 @@ import PartialExample from './_mentored.mdx'; import Admonition from '@theme/Admonition'; import BulkUploadTable from './_sessionbulkuploadtable.mdx'; import FormFieldsNote from './_formfieldscustomizability.mdx'; +import BurgerMenu from './media/burgermenu-icon.png' + # Creating Sessions for an Organization @@ -18,8 +20,9 @@ Sessions can be created using any one of the following methods: 1. Do one of the following actions: - * Select Workspace from the Application menu. - * Go to the Application menu ![](media/burgermenu-icon.png) and select Workspace. + * On desktop: Select Workspace from the left panel. + + * On mobile: Tap the icon and select Workspace. 2. On the Workspace page, click Manage session. @@ -234,9 +237,10 @@ For an organization's mentorship program, you can create and schedule multiple s **To create sessions through bulk upload, do as follows:** 1. Do one of the following actions: + + * On desktop: Select Workspace from the left panel. - * Select Workspace from the Application menu. - * Go to the Application menu ![](media/burgermenu-icon.png) and select Workspace. + * On mobile: Tap the icon and select Workspace. 2. On the Workspace page, click **Manage session**. @@ -277,3 +281,4 @@ For an organization's mentorship program, you can create and schedule multiple s + diff --git a/src/docusaurus/docs/creating-and-managing-mentee-profile.mdx b/src/docusaurus/docs/creating-and-managing-mentee-profile.mdx index 543fbf5..7c60740 100644 --- a/src/docusaurus/docs/creating-and-managing-mentee-profile.mdx +++ b/src/docusaurus/docs/creating-and-managing-mentee-profile.mdx @@ -1,5 +1,6 @@ import Admonition from '@theme/Admonition'; import FormFieldsNote from './_formfieldscustomizability.mdx'; +import BurgerMenu from './media/burgermenu-icon.png'; # Creating a Mentee Profile @@ -67,14 +68,12 @@ To view the Profile page, do one of the following actions: * Do one of the following actions: - * Select Profile from the Application menu. - * Go to the Application menu ![burger menu](media/burgermenu-icon.png) and select Profile. + * On desktop: Select Profile from the left panel. + * On mobile: Tap the icon and select Profile from the left panel. - ![](media/portal-menteeapplicationmenu.png) + ![](media/portal-mentorapplicationmenu.png) -* Go to the Profile tab. - ![](media/profile-icon.png) ### Updating Your Profile @@ -101,11 +100,10 @@ You can view the list of additional roles (such as mentor, session manager, and To view the list of assigned roles, do any one of the following actions: -* Click the **View roles** link on the Profile page. +* On desktop: Click View roles on the left panel. -* Do one of the following actions: +* On mobile: Tap the icon and click View roles on the left panel. - * Click the **View roles** link on the Application menu - * Go to the Application menu ![burger menu](media/burgermenu-icon.png) and click **View roles** link. + ![](media/viewroles-mentee.png) \ No newline at end of file diff --git a/src/docusaurus/docs/creating-and-managing-mentor-profile.mdx b/src/docusaurus/docs/creating-and-managing-mentor-profile.mdx index ac5331f..3f3d679 100644 --- a/src/docusaurus/docs/creating-and-managing-mentor-profile.mdx +++ b/src/docusaurus/docs/creating-and-managing-mentor-profile.mdx @@ -1,5 +1,7 @@ import Admonition from '@theme/Admonition'; import FormFieldsNote from './_formfieldscustomizability.mdx'; +import BurgerMenu from './media/burgermenu-icon.png'; + # Creating a Mentor Profile @@ -72,14 +74,11 @@ To view the Profile page, do one of the following actions: * Do one of the following actions: - * Select Profile from the Application menu. - * Go to the Application menu ![burger menu](media/burgermenu-icon.png) and select Profile. - - ![](media/portal-menteeapplicationmenu.png) + * On desktop: Select Profile from the left panel. + * On mobile: Tap the icon and select Profile from the left panel. -* Go to the Profile tab. - - ![](media/profile-icon.png) + ![](media/portal-mentorapplicationmenu.png) + ### Updating Your Profile @@ -110,11 +109,9 @@ You can view the list of additional roles (such as session manager or organizati To view the list of assigned roles, do any one of the following actions: -* Click the **View roles** link on the Profile page. +* On desktop: Click View roles on the left panel. -* Do one of the following actions: +* On mobile: Tap the icon and click View roles on the left panel. - * Click the **View roles** link on the Application menu - * Go to the Application menu ![burger menu](media/burgermenu-icon.png) and click **View roles** link. ![](media/viewroles-mentor.png) \ No newline at end of file diff --git a/src/docusaurus/docs/dashboard-for-mentees.mdx b/src/docusaurus/docs/dashboard-for-mentees.mdx index 393614f..325efc1 100644 --- a/src/docusaurus/docs/dashboard-for-mentees.mdx +++ b/src/docusaurus/docs/dashboard-for-mentees.mdx @@ -12,21 +12,21 @@ The Dashboard provides a summary of the number of sessions attended by the mente
  1. To view the Dashboard page, do any one of the following actions:
    2. +
+

- - + The mentee dashboard helps to track the total number of sessions attended by the mentees and also the total time spent for learning activities. diff --git a/src/docusaurus/docs/dashboard-for-mentors.mdx b/src/docusaurus/docs/dashboard-for-mentors.mdx index 936d2dc..c101555 100644 --- a/src/docusaurus/docs/dashboard-for-mentors.mdx +++ b/src/docusaurus/docs/dashboard-for-mentors.mdx @@ -12,21 +12,22 @@ The Dashboard provides a summary of the number of sessions conducted and attende
  1. To view the Dashboard page, do any one of the following actions:
    2. +
+

- - + + By default, the dashboard displays the mentoring session details for a mentee. You need to change the role to mentor. To change to mentor, select the Mentor role from the **Role** dropdown. diff --git a/src/docusaurus/docs/dashboard-for-sm.mdx b/src/docusaurus/docs/dashboard-for-sm.mdx index 4a2b365..a06ae7f 100644 --- a/src/docusaurus/docs/dashboard-for-sm.mdx +++ b/src/docusaurus/docs/dashboard-for-sm.mdx @@ -15,21 +15,22 @@ and the mentor rating received for the sessions conducted.
  1. To view the Dashboard page, do any one of the following actions:
    2. +
+

- - + + By default, the dashboard displays the mentoring session details for a mentee. You need to change the role to session manager. diff --git a/src/docusaurus/docs/joinassignedsession.mdx b/src/docusaurus/docs/joinassignedsession.mdx index a4c9e89..5f2d0c5 100644 --- a/src/docusaurus/docs/joinassignedsession.mdx +++ b/src/docusaurus/docs/joinassignedsession.mdx @@ -2,6 +2,7 @@ import Admonition from '@theme/Admonition'; import PartialExample from './_mentored.mdx'; import JoinStepPortal from './_joinsessionstep-portal.mdx'; import ViewSessionList from './media/sessionlist-view.png'; +import BurgerMenu from './media/burgermenu-icon.png' # Joining Sessions Assigned to Mentors @@ -20,10 +21,10 @@ Before joining a Public or Private session, you must enroll for the session. **To enroll for a session, do as follows:** 1. Do one of the following actions: + + * On desktop: Select Workspace from the left panel. - * Select Workspace from the Application menu. - - * Go to the Application menu ![burger menu](media/burgermenu-icon.png) and select Workspace. + * On mobile: Tap the icon and select Workspace. 2. Click **Manage sessions**. The Session list section appears. diff --git a/src/docusaurus/docs/manageassignedsession.mdx b/src/docusaurus/docs/manageassignedsession.mdx index ccaeece..8f060c9 100644 --- a/src/docusaurus/docs/manageassignedsession.mdx +++ b/src/docusaurus/docs/manageassignedsession.mdx @@ -1,5 +1,6 @@ import Admonition from '@theme/Admonition'; import BulkUploadTable from './_sessionbulkuploadtable.mdx'; +import BurgerMenu from './media/burgermenu-icon.png' # Managing Sessions Assigned to Mentors @@ -21,9 +22,9 @@ After publishing sessions, the list of sessions appear on the Session list secti 1. Do one of the following actions: - * Select Workspace from the Application menu. - - * Go to the Application menu ![burger menu](media/burgermenu-icon.png) and select Workspace. + * On desktop: Select Workspace from the left panel. + + * On mobile: Tap the icon and select Workspace. 2. Click **Manage sessions**. @@ -199,9 +200,9 @@ You can update the session or meeting information only until the scheduled start 1. Do one of the following actions: - * Select Workspace from the Application menu. - - * Go to the Application menu ![burger menu](media/burgermenu-icon.png) and select Workspace. + * On desktop: Select Workspace from the left panel. + + * On mobile: Tap the icon and select Workspace. 2. Click **Manage sessions**. @@ -280,9 +281,10 @@ To delete multiple sessions, you can upload a CSV file containing the list of se 1. Do one of the following actions: - * Select Workspace from the Application menu. + * On desktop: Select Workspace from the left panel. + + * On mobile: Tap the icon and select Workspace. - * Go to the Application menu ![burger menu](media/burgermenu-icon.png) and select Workspace. 2. Go to the **Bulk upload** tab. diff --git a/src/docusaurus/docs/managementorrequests.mdx b/src/docusaurus/docs/managementorrequests.mdx index b997ea8..a34a287 100644 --- a/src/docusaurus/docs/managementorrequests.mdx +++ b/src/docusaurus/docs/managementorrequests.mdx @@ -1,3 +1,7 @@ +import Admonition from '@theme/Admonition'; +import BurgerMenu from './media/burgermenu-icon.png' + + # Managing Requests to Become a Mentor After mentees raise a request to become a mentor, the organization administrator can review their profile details and accept or reject the request. @@ -5,14 +9,16 @@ After mentees raise a request to become a mentor, the organization administrator **To accept requests to become a mentor, do as follows:** 1. Do one of the following actions: - * Select **Workspace** from the **Application** menu. - * Go to the **Application** menu ![burger menu](media/burgermenu-icon.png) and select **Workspace**. + * On desktop: Select Workspace from the left panel. + + * On mobile: Tap the icon and select Workspace. + 2. On the Workspace page, click **Manage user**. The Manage user page appears. ![](media/orgadmin-managerequests.png) -4. On the Manage Request tab, do one of the following actions: +3. On the Manage Request tab, do one of the following actions: * To review the profile details, click **View** ![](media/orgadmin-viewmentordetails.png). diff --git a/src/docusaurus/docs/media/acceptorreject.png b/src/docusaurus/docs/media/acceptorreject.png new file mode 100644 index 0000000..3e473f6 Binary files /dev/null and b/src/docusaurus/docs/media/acceptorreject.png differ diff --git a/src/docusaurus/docs/media/acceptrejectsessionrequest.png b/src/docusaurus/docs/media/acceptrejectsessionrequest.png new file mode 100644 index 0000000..6946e49 Binary files /dev/null and b/src/docusaurus/docs/media/acceptrejectsessionrequest.png differ diff --git a/src/docusaurus/docs/media/dashboard-icon.png b/src/docusaurus/docs/media/dashboard-icon.png index f103a0d..151dcda 100644 Binary files a/src/docusaurus/docs/media/dashboard-icon.png and b/src/docusaurus/docs/media/dashboard-icon.png differ diff --git a/src/docusaurus/docs/media/mentee-myconnections.png b/src/docusaurus/docs/media/mentee-myconnections.png new file mode 100644 index 0000000..15a9d02 Binary files /dev/null and b/src/docusaurus/docs/media/mentee-myconnections.png differ diff --git a/src/docusaurus/docs/media/menteefilter.png b/src/docusaurus/docs/media/menteefilter.png new file mode 100644 index 0000000..b6540c0 Binary files /dev/null and b/src/docusaurus/docs/media/menteefilter.png differ diff --git a/src/docusaurus/docs/media/menteemessagerequest.png b/src/docusaurus/docs/media/menteemessagerequest.png new file mode 100644 index 0000000..8efcebc Binary files /dev/null and b/src/docusaurus/docs/media/menteemessagerequest.png differ diff --git a/src/docusaurus/docs/media/menteemessages.png b/src/docusaurus/docs/media/menteemessages.png new file mode 100644 index 0000000..c95a8da Binary files /dev/null and b/src/docusaurus/docs/media/menteemessages.png differ diff --git a/src/docusaurus/docs/media/menteesendingfirstmessage.png b/src/docusaurus/docs/media/menteesendingfirstmessage.png new file mode 100644 index 0000000..58bb462 Binary files /dev/null and b/src/docusaurus/docs/media/menteesendingfirstmessage.png differ diff --git a/src/docusaurus/docs/media/menteesendingmessage.png b/src/docusaurus/docs/media/menteesendingmessage.png new file mode 100644 index 0000000..0aab0b8 Binary files /dev/null and b/src/docusaurus/docs/media/menteesendingmessage.png differ diff --git a/src/docusaurus/docs/media/menteesessionrequest-viewdetails.png b/src/docusaurus/docs/media/menteesessionrequest-viewdetails.png new file mode 100644 index 0000000..6aeceb4 Binary files /dev/null and b/src/docusaurus/docs/media/menteesessionrequest-viewdetails.png differ diff --git a/src/docusaurus/docs/media/menteesessionrequest.png b/src/docusaurus/docs/media/menteesessionrequest.png new file mode 100644 index 0000000..6b8c189 Binary files /dev/null and b/src/docusaurus/docs/media/menteesessionrequest.png differ diff --git a/src/docusaurus/docs/media/mentor-addlink.png b/src/docusaurus/docs/media/mentor-addlink.png new file mode 100644 index 0000000..0ce5493 Binary files /dev/null and b/src/docusaurus/docs/media/mentor-addlink.png differ diff --git a/src/docusaurus/docs/media/mentorconnections.png b/src/docusaurus/docs/media/mentorconnections.png new file mode 100644 index 0000000..b5dc0eb Binary files /dev/null and b/src/docusaurus/docs/media/mentorconnections.png differ diff --git a/src/docusaurus/docs/media/mentordirectory-icon.PNG b/src/docusaurus/docs/media/mentordirectory-icon.PNG index c7a3911..beb94be 100644 Binary files a/src/docusaurus/docs/media/mentordirectory-icon.PNG and b/src/docusaurus/docs/media/mentordirectory-icon.PNG differ diff --git a/src/docusaurus/docs/media/mentordirectory.png b/src/docusaurus/docs/media/mentordirectory.png new file mode 100644 index 0000000..122d295 Binary files /dev/null and b/src/docusaurus/docs/media/mentordirectory.png differ diff --git a/src/docusaurus/docs/media/mentorfilter.png b/src/docusaurus/docs/media/mentorfilter.png new file mode 100644 index 0000000..3ade38b Binary files /dev/null and b/src/docusaurus/docs/media/mentorfilter.png differ diff --git a/src/docusaurus/docs/media/mentormessagerequest.png b/src/docusaurus/docs/media/mentormessagerequest.png new file mode 100644 index 0000000..c2ab302 Binary files /dev/null and b/src/docusaurus/docs/media/mentormessagerequest.png differ diff --git a/src/docusaurus/docs/media/mentormessages.png b/src/docusaurus/docs/media/mentormessages.png new file mode 100644 index 0000000..83afee5 Binary files /dev/null and b/src/docusaurus/docs/media/mentormessages.png differ diff --git a/src/docusaurus/docs/media/mentorsearchfilter.png b/src/docusaurus/docs/media/mentorsearchfilter.png new file mode 100644 index 0000000..c3f38ae Binary files /dev/null and b/src/docusaurus/docs/media/mentorsearchfilter.png differ diff --git a/src/docusaurus/docs/media/mentorsessionrequest.png b/src/docusaurus/docs/media/mentorsessionrequest.png new file mode 100644 index 0000000..6da590e Binary files /dev/null and b/src/docusaurus/docs/media/mentorsessionrequest.png differ diff --git a/src/docusaurus/docs/media/messagepageformentee.png b/src/docusaurus/docs/media/messagepageformentee.png new file mode 100644 index 0000000..abbe424 Binary files /dev/null and b/src/docusaurus/docs/media/messagepageformentee.png differ diff --git a/src/docusaurus/docs/media/messagepageformentor.png b/src/docusaurus/docs/media/messagepageformentor.png new file mode 100644 index 0000000..577d0ae Binary files /dev/null and b/src/docusaurus/docs/media/messagepageformentor.png differ diff --git a/src/docusaurus/docs/media/portal-applicationmenumentors.png b/src/docusaurus/docs/media/portal-applicationmenumentors.png index 4bc9648..2b7c01a 100644 Binary files a/src/docusaurus/docs/media/portal-applicationmenumentors.png and b/src/docusaurus/docs/media/portal-applicationmenumentors.png differ diff --git a/src/docusaurus/docs/media/portal-editmenteeprofile.png b/src/docusaurus/docs/media/portal-editmenteeprofile.png index 3cc446e..7514ce0 100644 Binary files a/src/docusaurus/docs/media/portal-editmenteeprofile.png and b/src/docusaurus/docs/media/portal-editmenteeprofile.png differ diff --git a/src/docusaurus/docs/media/portal-editmentorprofile.png b/src/docusaurus/docs/media/portal-editmentorprofile.png index 59bca76..65d91e5 100644 Binary files a/src/docusaurus/docs/media/portal-editmentorprofile.png and b/src/docusaurus/docs/media/portal-editmentorprofile.png differ diff --git a/src/docusaurus/docs/media/portal-menteeapplicationmenu.png b/src/docusaurus/docs/media/portal-menteeapplicationmenu.png index 5c59345..c5799d5 100644 Binary files a/src/docusaurus/docs/media/portal-menteeapplicationmenu.png and b/src/docusaurus/docs/media/portal-menteeapplicationmenu.png differ diff --git a/src/docusaurus/docs/media/portal-menteehomepage.png b/src/docusaurus/docs/media/portal-menteehomepage.png index c7ed543..ee62d83 100644 Binary files a/src/docusaurus/docs/media/portal-menteehomepage.png and b/src/docusaurus/docs/media/portal-menteehomepage.png differ diff --git a/src/docusaurus/docs/media/portal-mentorapplicationmenu.png b/src/docusaurus/docs/media/portal-mentorapplicationmenu.png index 322548c..1752cc3 100644 Binary files a/src/docusaurus/docs/media/portal-mentorapplicationmenu.png and b/src/docusaurus/docs/media/portal-mentorapplicationmenu.png differ diff --git a/src/docusaurus/docs/media/portal-mentordirectory-upcomingsessions.png b/src/docusaurus/docs/media/portal-mentordirectory-upcomingsessions.png index 57ceeb1..d253898 100644 Binary files a/src/docusaurus/docs/media/portal-mentordirectory-upcomingsessions.png and b/src/docusaurus/docs/media/portal-mentordirectory-upcomingsessions.png differ diff --git a/src/docusaurus/docs/media/portal-mentorhomepage.png b/src/docusaurus/docs/media/portal-mentorhomepage.png index 3d7df56..0182aac 100644 Binary files a/src/docusaurus/docs/media/portal-mentorhomepage.png and b/src/docusaurus/docs/media/portal-mentorhomepage.png differ diff --git a/src/docusaurus/docs/media/portal-mentorprofilepage.png b/src/docusaurus/docs/media/portal-mentorprofilepage.png index 1c3ae9f..5465f73 100644 Binary files a/src/docusaurus/docs/media/portal-mentorprofilepage.png and b/src/docusaurus/docs/media/portal-mentorprofilepage.png differ diff --git a/src/docusaurus/docs/media/rejectsessionrequest.png b/src/docusaurus/docs/media/rejectsessionrequest.png new file mode 100644 index 0000000..2a827e2 Binary files /dev/null and b/src/docusaurus/docs/media/rejectsessionrequest.png differ diff --git a/src/docusaurus/docs/media/requestsession.png b/src/docusaurus/docs/media/requestsession.png new file mode 100644 index 0000000..625c482 Binary files /dev/null and b/src/docusaurus/docs/media/requestsession.png differ diff --git a/src/docusaurus/docs/media/searchmentors.png b/src/docusaurus/docs/media/searchmentors.png index df1460e..31a9061 100644 Binary files a/src/docusaurus/docs/media/searchmentors.png and b/src/docusaurus/docs/media/searchmentors.png differ diff --git a/src/docusaurus/docs/media/sessionmanagerpage.png b/src/docusaurus/docs/media/sessionmanagerpage.png index 78933c7..7036fac 100644 Binary files a/src/docusaurus/docs/media/sessionmanagerpage.png and b/src/docusaurus/docs/media/sessionmanagerpage.png differ diff --git a/src/docusaurus/docs/media/sessionrequest-accept.png b/src/docusaurus/docs/media/sessionrequest-accept.png new file mode 100644 index 0000000..79ad0e7 Binary files /dev/null and b/src/docusaurus/docs/media/sessionrequest-accept.png differ diff --git a/src/docusaurus/docs/media/viewroles-mentee.png b/src/docusaurus/docs/media/viewroles-mentee.png index e5c17d1..2a815a6 100644 Binary files a/src/docusaurus/docs/media/viewroles-mentee.png and b/src/docusaurus/docs/media/viewroles-mentee.png differ diff --git a/src/docusaurus/docs/media/viewroles-mentor.png b/src/docusaurus/docs/media/viewroles-mentor.png index 21f39cf..8502aeb 100644 Binary files a/src/docusaurus/docs/media/viewroles-mentor.png and b/src/docusaurus/docs/media/viewroles-mentor.png differ diff --git a/src/docusaurus/docs/mentee-request.mdx b/src/docusaurus/docs/mentee-request.mdx new file mode 100644 index 0000000..6ddc499 --- /dev/null +++ b/src/docusaurus/docs/mentee-request.mdx @@ -0,0 +1,49 @@ +import Admonition from '@theme/Admonition'; +import BurgerMenu from './media/burgermenu-icon.png'; + +# Viewing Sent Requests + +On the request page, you can view all sent requests (such as message requests and session requests) +that are yet to be accepted by the mentors. + +You can view the following details: + +* View the message requests sent to the mentors whom you wish to connect with. + +* View the session requests sent to the mentors. + +To view the Message Requests, do any one of the following actions: + +* On desktop: Select Requests from the left panel. The Request page appears. + +* On mobile: Tap the icon and select Requests. + + +The Request page contains two tabs: (1) **Session requests** (2) **Message requests** + +## Viewing Message Requests + +The Message requests tab will list all the message requests sent to the mentors' whom you wish to connect with. + + + ![](media/menteemessagerequest.png) + +* Click anywhere on the mentor's card to view their profile. + +* Click **View Message** to open the chat window. Here, you can see the first message sent to the mentor. + +## Viewing Session Requests + +The Session requests tab lists all the session requests you have sent to the mentors. + +![](media/menteesessionrequest.png) + +You can view the session details and the mentor's profile. To view the session details, click **View details**. + +![](media/menteesessionrequest-viewdetails.png) + +Click **View profile** to view the profile details of the mentor. + + + + diff --git a/src/docusaurus/docs/mentee-viewchatmessages.mdx b/src/docusaurus/docs/mentee-viewchatmessages.mdx new file mode 100644 index 0000000..9e84a53 --- /dev/null +++ b/src/docusaurus/docs/mentee-viewchatmessages.mdx @@ -0,0 +1,25 @@ +import Admonition from '@theme/Admonition'; + +# Viewing Chat Messages + +Here, you can view the chat messages you have sent or received from the mentor. By default, the most recent messages are displayed on the top of the page. + +![](media/menteemessages.png) + + + +

A green dot on the Message on the left panel indicates that you have received a new message.

+ + +Select the row that corresponds to the mentor whose chat messages you wish to view. The chat window appears. + + ![](media/messagepageformentee.png) + + You can also send a message to the mentor using the text box provided at the bottom of the window. + + ## Search + + To search for a specific mentor, type three or more letters in the **Search by name** text box + located on the top of the page. The search results appear based on the search term you have typed in the search box. + + diff --git a/src/docusaurus/docs/menteesconnections.mdx b/src/docusaurus/docs/menteesconnections.mdx new file mode 100644 index 0000000..6b9d3a4 --- /dev/null +++ b/src/docusaurus/docs/menteesconnections.mdx @@ -0,0 +1,74 @@ +import Admonition from '@theme/Admonition'; + +# Managing Mentee Connections + +On the My Connections page, you will see a list of mentors who have accepted your message requests or session requests. You can view their profiles and communicate with +them online. + +The mentor's details are displayed as cards as shown in the following figure. +Each card displays the mentor's image, name, designation, and years of experience. You can chat with the mentor and also request +for a session using the **Chat** and **Request session** option available on the mentor's card. + +![](media/mentee-myconnections.png) + +## Working with Chat and Request Session + +The **Chat** feature enables you to communicate with a mentor in real-time through text messages. + +**To chat with the mentor, do as follows:** + +1. Click **Chat** on the mentor's card to open the chat window. + +![](media/menteesendingmessage.png) + +2. Type your message in the space provided at the bottom of the page. + +3. Click the send button to send your message. + + +**To request a session, do as follows:** + +1. Click **Request session** on the mentor card. + +2. Enter a **Title** for the session. + +3. Select the **Start date** and the **End date** using the calendar icon. + +![](media/requestsession.png) + +4. Enter the **Agenda** for the session. + +5. Click **Submit request**. A message appears stating that your request has been sent successfully. + + +## Finding Mentors Using the Search Connections + + +To find mentors on the my connections page, type the mentor's name or the area of expertise in the Search connections box. Type +three or more letters of the mentor's name or area of expertise and then press **Enter**. The search results appear as mentor cards. + + + +## Filter + +You can filter the search results using the **Filter** option located on the upper-right corner of the page. +You can use the criteria such as **Area of Expertise**, **Designation**, and **Organizations**. + +**To apply a filter do as follows:** + +1. Click the **Filter** option on the upper-right corner of the page. + +2. Select the required criteria from the **Filter** dialog box. + +![](media/menteefilter.png) + +3. Click **Apply** to apply the filter. + + +

To clear filters, do one of the following actions:

+ + + diff --git a/src/docusaurus/docs/mentor-directory.mdx b/src/docusaurus/docs/mentor-directory.mdx index ae6c609..e8a6f0c 100644 --- a/src/docusaurus/docs/mentor-directory.mdx +++ b/src/docusaurus/docs/mentor-directory.mdx @@ -3,48 +3,64 @@ import Admonition from '@theme/Admonition'; # Mentor Directory -The Mentor Directory lists mentor profiles in an alphabetical order. Using the Mentor Directory, you can discover mentors in your chosen area of expertise and view their mentor profile. +The mentor directory lists the mentors' profiles in an alphabetical order. Using the mentor directory you can perform the following actions: -To view the Mentor Directory, do any one of the following actions: +* View all the mentors existing on the platform. -* Select **Mentors** from the **Application** menu. +* View all the mentors' profiles. To do this, click anywhere on the mentor's card. -* Go to the **Application** menu ![](media/burgermenu-icon.png) and select **Mentors**. +* Send a chat request or a session request to a mentor. - ![](media/portal-applicationmenumentors.png) -* Go to the Mentors tab. +**To view the Mentor Directory, do any one of the following actions:** + +* On desktop: Select Mentors from the left panel. The mentor directory appears. + + +The mentor directory lists all the mentors present +on the platform in a card format in alphabetical order, as shown in the following figure. + + + + ![](media/mentordirectory.png) + + + +* On mobile: Go to the application and click the Mentors tab located at the bottom of the screen. ![](media/mentordirectory-icon.PNG) ## Finding Mentors Using the Search Box -To find mentors on the Mentor Directory, enter a keyword such as the mentor's name or the area of expertise in the **Search** box and press **Enter**. The search results appear as mentor profile tiles. +To find mentors on the Mentor Directory, enter a keyword such as the mentor's name or the area of expertise in the **Search** box and press **Enter**. The search results appear as mentor card tiles. +
To refine your search results, you can also search for mentors based on a specific category. Click here for the following actions: -1. To specify the search category, refer to the following table: +Type three or more letters of the name of the mentor or area of expertise in the search box and then press Enter. +The search results appear based on the search term you have typed in the search box. + + ![](media/searchmentors.png) + + +Filter + +You can filter the search results using the Filter option located on the top-right corner of the page. +You can use the criteria such as Area of Expertise, Designation, or Organizations. + +To apply a filter do as follows: - - - - - - - - - - - - - -
CategoryActions
Search CategoryClick the Search box and select a search category such as Area of Expertise.
Filter
  1. Click on Filter.
  2. Select one or more filters and click Apply.

    3. To clear filters, do one of the following actions:

    • Clear the filter checkbox.
    • Click Clear all to clear all the applied filters.
+1. Click the Filter option on the top-right corner of the page. -2. Enter the search keyword. Based on the selected category, the search results appear as mentor profile tiles. +2. Select the required criteria from the Filter dialog box. - ![](media/searchmentors.png) +![](media/menteefilter.png) + +3. Click Apply to apply the filter. + +To clear the filter click Clear all.
@@ -65,33 +81,25 @@ On the Mentor Profile page, you can do the following actions: * View the ratings they received for sessions. -* View the additional roles assigned to the mentor. +* Send a chat request or session request to a mentor. * Discover the upcoming sessions of the mentor. -* Enroll and join sessions. - * Share a mentor profile using a link. + **To view the Mentor Profile page, do as follows:** -1. On the Mentor Directory, find a mentor and click the mentor profile tile. +1. On the Mentor Directory, click anywhere on the mentor's card whose profile you wish to view. 2. Go to the About tab to view the profile details. ![](media/portal-mentorprofilepage.png) -### Viewing Roles Assigned to a Mentor - -You can view the list of additional roles (such as session manager or organization administrator) that are assigned to a mentor by an organization. -

Every user who registers on the platform is a mentee by default.

 -To view the list of assigned roles, click the **View roles** link on the Mentor Profile page. - -![](media/portal-mentorprofilepage.png) ### Finding the Upcoming Sessions of the Mentor @@ -113,9 +121,80 @@ You can share mentor profile links with your contacts. **To share mentor profile links, do as follows:** -1. On the Mentor profile page, click **Share profile** to copy the mentor profile link. +1. On the Mentor profile page, click **Share** to copy the mentor profile link. 2. Share the mentor profile link with your contacts. ![](media/portal-mentorprofilepage.png) +## Sending a Message Request to the Mentor + +Using the **Chat** option, you can send a message to the mentor. The mentor can accept or reject the message request. + +**To chat with the mentor, do as follows:** + +1. Click **Chat** on the mentor's card you wish to connect to. The chat window appears. + +![](media/menteesendingfirstmessage.png) + +2. Type your message in the space provided at the bottom of the page. + +3. Click the send button to send your message. + + You will be able to start the conversation through messages only after the mentor accepts the request and + a connection is established. + + +

+

+

+ + +### Accepting or Rejecting Message Requests + +After the mentee sends a message, the mentor can accept or reject the chat request. +The mentee can continue to communicate with the mentor if the mentor accepts the request. +Upon rejecting the request, the mentee will receive an email notification for rejecting the chat request. + + + +## Sending a Session Request to the Mentor + +The mentee can request for a session using the **Request session** option. + +**To request a session, do as follows:** + +1. Click **Request session** on the mentor card. + +2. Enter a title for the session. + +3. Set the start date and the end date using the calendar icon. + +4. Enter the agenda for the session. + +5. Click **Submit request**. A message appears stating that your request has been sent successfully. + + +### Accepting or Rejecting Session Requests + +After the mentee sends a session request, the mentor can accept or reject the session request. +The mentee can continue to communicate with the mentor if the mentor accepts the request. +Upon rejecting the request, the mentee receives an email notification for rejecting the session request. +Optionally, if the rejection reason was provided, it will be included in the notification. + + + + + + + + + + diff --git a/src/docusaurus/docs/mentor-request.mdx b/src/docusaurus/docs/mentor-request.mdx new file mode 100644 index 0000000..a363e19 --- /dev/null +++ b/src/docusaurus/docs/mentor-request.mdx @@ -0,0 +1,84 @@ +import Admonition from '@theme/Admonition'; + +# Responding to Requests + +The Request page allows you to manage your connections. You can view the pending connections and also +decide whether to accept or reject the requests. + +To view the session requests and the message requests, do as follows: + +1. Select **Requests** from the left panel. The Requests page appears. + +2. There are two tabs: (1) **Session requests** (2) **Message requests** + +## Managing Session Requests + +This tab shows the session requests that you have received, but have not yet accepted them. + + ![](media/mentorsessionrequest.png) + +To view the session request details, click **View details**. + +## Accept or Reject Session Requests + +After you receive a session request, you can accept or reject the request. + +**To accept or reject a session request, do as follows:** + +1. Select the **Session requests** tab. + +2. Click **View details**. The session details page appears. + + ![](media/acceptrejectsessionrequest.png) + +3. Do one of the following: + + * Click **Accept** to accept the request. A message appears stating that your session request has been accepted. + + ![](media/sessionrequest-accept.png) + + You can share the session link with your mentee now or add it later. To share the link, click **Add link** and then enter the meeting link + in the space provided. + + ![](media/mentor-addlink.png) + + * Click **Reject** to reject the request. A message appears to confirm whether you want to reject this session request. + Optionally, you can provide a reason for rejecting the request or an alternative time slot in the space provided. + + ![](media/rejectsessionrequest.png) + + +4. Click **Reject** to reject the session request or **Cancel** to return to the session details page. + +## Managing Message Requests + +This tab shows the message requests that you have received, but have not yet accepted them. + + ![](media/mentormessagerequest.png) + + +## Accept or Reject Message Requests + +After you receive a chat request from a mentee or mentor, you can accept or reject the request. + +**To accept or reject a message request, do as follows:** + +1. Select the **Message requests** tab. + +2. Click **View Message**. The message request page appears. + + ![](media/acceptorreject.png) + +3. Do one of the following: + + * Click **Accept** to accept the request. A message appears stating that you have accepted the request and the mentee is added to your connections. + + * Click **Reject** to reject the request. A message appears to confirm whether you want to reject this message request. + +4. Click **Reject** on the message dialog box to reject the message request or **Cancel** to return to the message request page. + + + + + + diff --git a/src/docusaurus/docs/mentor-viewchatmessages.mdx b/src/docusaurus/docs/mentor-viewchatmessages.mdx new file mode 100644 index 0000000..b9b3570 --- /dev/null +++ b/src/docusaurus/docs/mentor-viewchatmessages.mdx @@ -0,0 +1,23 @@ +# Viewing Chat Messages + +You can view all chat messages from the mentees or mentors who are connected to you. +This includes both the messages you have sent and the messages you have received. By default, the most recent messages are displayed +on the top of the page. + + + + ![](media/mentormessages.png) + +Select the row that corresponds to the mentee or mentor whose chat messages you wish to view. The chat window appears. + + + ![](media/messagepageformentor.png) + + You can also send a message to the mentee using the text box provided at the bottom of the window. + + ## Search + + To search for a specific mentee or mentor, type three or more letters in the **Search by name** text box + located on the top of the page. The search results appear based on the search term you have typed in the search box. + + diff --git a/src/docusaurus/docs/mentorsconnections.mdx b/src/docusaurus/docs/mentorsconnections.mdx new file mode 100644 index 0000000..94a3564 --- /dev/null +++ b/src/docusaurus/docs/mentorsconnections.mdx @@ -0,0 +1,92 @@ +import Admonition from '@theme/Admonition'; + +# Managing Mentor Connections + +On the My Connections page, you can see the list of mentees and mentors who are connected to you. + +You can do the following actions on the my connections page: + +* View the profile details of a mentee or a mentor. + +* Chat with a mentee or a mentor. + +* Request for a session with a mentor. + +* Find a specific mentor or mentee using the search connections. + + +![](media/mentorconnections.png) + + + + + + +## Viewing the Mentee Profile + +Click on the profile image to view the profile details of the mentee. + + +**To chat with a mentee or mentor do as follows:** + +1. Click **Chat**. The Chat window appears. + +2. Type the message in the space provided at the bottom of the chat window. + +3. Click the send button to send your response. + +**To request a session, do as follows:** + +1. Click **Request session** on the mentor card. + +2. Enter a title for the session. + +3. Set the the start date and the end date using the calendar icon. + +4. Enter the agenda for the session. + +5. Click **Submit request**. A message appears stating that your request has been sent successfully. + +## Search Connections + + +Use the **Search connections** option to find a specific mentor or mentee. + +![](media/mentorsearchfilter.png) + +You can search either by **Mentor name** or **Area of Expertise**. To do this, type three or more letters of the mentor's name or area of expertise in the search box +and then press **Enter**. The search results appear based on the search term you typed. + +## Filter + +You can filter the search results using the **Filter** option located on the upper-right corner of the page. +You can use the criteria such as **Roles**, **Area of Expertise**, **Designation**, and **Organizations**. + +**To apply a filter do as follows:** + +1. Click the **Filter** option on the upper-right corner of the page. + +2. Select the required criteria from the **Filter** dialog box. + +![](media/mentorfilter.png) + +3. Click **Apply** to apply the filter. + + +

To clear filters, do one of the following actions:

+ + + + + + + + + diff --git a/src/docusaurus/docs/report-an-issue.mdx b/src/docusaurus/docs/report-an-issue.mdx index b74917c..3cffcdf 100644 --- a/src/docusaurus/docs/report-an-issue.mdx +++ b/src/docusaurus/docs/report-an-issue.mdx @@ -12,8 +12,8 @@ You can write to the support team about any problems you faced while using the a
  1. Do one of the following actions:
  2. On the Help page, select Report an issue option from the help menu.
  3. Enter the details of the issue you faced in the Report an issue box.
    4. diff --git a/src/docusaurus/docs/signing-up-as-a-mentee.mdx b/src/docusaurus/docs/signing-up-as-a-mentee.mdx index 7183db8..9ef2178 100644 --- a/src/docusaurus/docs/signing-up-as-a-mentee.mdx +++ b/src/docusaurus/docs/signing-up-as-a-mentee.mdx @@ -19,9 +19,9 @@ You can create an account as a mentee if you received: To log out, do one of the following actions: -* Select Logout from the Application menu. +* On desktop: Select Logout from the left panel. -* Go to the Application menu and select Logout. +* On mobile: Tap the icon and select Logout.

    diff --git a/src/docusaurus/docs/signing-up-as-a-mentor.mdx b/src/docusaurus/docs/signing-up-as-a-mentor.mdx index c99426e..593178f 100644 --- a/src/docusaurus/docs/signing-up-as-a-mentor.mdx +++ b/src/docusaurus/docs/signing-up-as-a-mentor.mdx @@ -16,10 +16,11 @@ After receiving the application's link from your organization through an email i To log out, do one of the following actions: -* Select Logout from the Application menu. +* On desktop: Select Logout from the left panel. -* Go to the Application menu and select Logout. +* On mobile: Tap the icon and select Logout.

    -

    \ No newline at end of file +

    + diff --git a/src/docusaurus/docs/starting-a-session.mdx b/src/docusaurus/docs/starting-a-session.mdx index 5c2f987..61ab725 100644 --- a/src/docusaurus/docs/starting-a-session.mdx +++ b/src/docusaurus/docs/starting-a-session.mdx @@ -34,7 +34,7 @@ You can start a session in one of the following ways: ## Using the Start Button
      -
    1. On your Home page, go the My mentoring sessions tab.
      2. +
    2. On your Home page, go to the My mentoring sessions tab.
    3. Find the session.
    4. Click Start. The meeting window appears.

      5. @@ -61,7 +61,7 @@ You can start a session in one of the following ways: ## Using the Session Details Page

        -
      1. On your Home page, go the My mentoring sessions tab.
        2. +
      2. On your Home page, go to the My mentoring sessions tab.
      3. Click the session tile to view the Session Details page.

        4. diff --git a/src/docusaurus/docs/using-faq.mdx b/src/docusaurus/docs/using-faq.mdx index 87f104f..799f89f 100644 --- a/src/docusaurus/docs/using-faq.mdx +++ b/src/docusaurus/docs/using-faq.mdx @@ -1,3 +1,5 @@ +import BurgerMenu from './media/burgermenu-icon.png' + # Using the FAQ Page You can find answers to commonly asked questions about the application. @@ -5,8 +7,9 @@ You can find answers to commonly asked questions about the application. **To view the FAQ page, do as follows:** 1. Do one of the following actions: - * Select **FAQ** from the **Application** menu. - * Go to the **Application** menu ![burger menu](media/burgermenu-icon.png) and select **FAQ**. + + * On desktop: Select FAQ from the left panel. + * On mobile: Tap the icon and select FAQ. 2. On the FAQ page, click the dropdown icon located next to question to view the answer. diff --git a/src/docusaurus/docs/view-helpvideos.mdx b/src/docusaurus/docs/view-helpvideos.mdx index 794db42..06de4df 100644 --- a/src/docusaurus/docs/view-helpvideos.mdx +++ b/src/docusaurus/docs/view-helpvideos.mdx @@ -1,3 +1,5 @@ +import BurgerMenu from './media/burgermenu-icon.png' + # Viewing the Help Videos You can find video instructions about using the application features. @@ -5,8 +7,10 @@ You can find video instructions about using the application features. **To view the video instructions, do as follows:** 1. Do one of the following actions: - * Select **Help videos** from the **Application** menu. - * Go to the **Application** menu ![burger menu](media/burgermenu-icon.png) and select **Help videos**. + + * On desktop: Select User Guide Videos from the left panel. + + * On mobile: Tap the icon and select User Guide Videos. 2. Click the appropriate tile to play the video instructions. diff --git a/src/docusaurus/docusaurus.config.js b/src/docusaurus/docusaurus.config.js index 36ed8f5..25757bb 100644 --- a/src/docusaurus/docusaurus.config.js +++ b/src/docusaurus/docusaurus.config.js @@ -38,14 +38,25 @@ const config = { lastVersion: 'current', versions: { current: { - label: '3.1', + label: 'Mentor 3.2', }, + "3.1": { + label: 'Mentor 3.1', + path: '3.1', + }, + + "3.0": { + label: 'Mentor 3.0', + path: '3.0', + }, + "2.6": { - label: '2.6', + label: 'Mentor 2.6', path: '2.6', }, + "2.5": { - label: '2.5', + label: 'Mentor 2.5', path: '2.5', }, } @@ -185,6 +196,15 @@ const config = { sidebarPath: require.resolve('./sidebarsSolutionuploadportal.js'), }, ], + [ + '@docusaurus/plugin-content-docs', + { + id: 'userservices', + path: 'userservices', + routeBasePath: 'userservices', + sidebarPath: require.resolve('./sidebarsUserservices.js'), + }, + ], ], themeConfig: @@ -210,7 +230,15 @@ const config = { src: 'img/elevate-logo.png', }, items: [ + { + + type: 'docsVersionDropdown', + position: 'left', + dropdownActiveClassDisabled: true, + }, + +/* { type: 'doc', docId: 'intro', @@ -218,6 +246,7 @@ const config = { label: 'Mentor', // logo: 'img/mentoring-logo.png', }, +*/ { type: 'doc', docId: 'intro', @@ -276,15 +305,26 @@ const config = { docsPluginId: 'solutionuploadportal', label: 'Solution Upload Portal', }, - + ], - }, + }, + { + type: 'doc', + docId: 'intro', + docsPluginId: 'userservices', + position: 'left', + label: 'User Services', + }, + + + { href: 'https://elevate.shikshalokam.org/contact-us/', label: 'Help', position: 'right', }, - + + /* {to: '/blog', label: 'Blog', position: 'left'}, diff --git a/src/docusaurus/sidebars.js b/src/docusaurus/sidebars.js index 3569945..c9d2e7c 100644 --- a/src/docusaurus/sidebars.js +++ b/src/docusaurus/sidebars.js @@ -187,6 +187,23 @@ const sidebars = { id: 'creating-and-managing-mentor-profile', // document ID label: 'Creating a Profile', // sidebar label }, + { + type: 'doc', + id: 'mentorsconnections', // document ID + label: 'Managing Mentor Connections', // sidebar label + }, + { + type: 'doc', + id: 'mentor-request', // document ID + label: 'Responding to a Request', // sidebar label + }, + + { + type: 'doc', + id: 'mentor-viewchatmessages', // document ID + label: 'Viewing Chat Messages', // sidebar label + }, + { type: 'doc', id: 'setting-up-a-session', // document ID @@ -249,6 +266,21 @@ const sidebars = { type: 'doc', id: 'mentor-directory', // document ID label: 'Using the Mentor Directory', // sidebar label + }, + { + type: 'doc', + id: 'mentee-request', // document ID + label: 'Viewing Sent Requests', // sidebar label + }, + { + type: 'doc', + id: 'menteesconnections', // document ID + label: 'Managing Mentee Connections', // sidebar label + }, + { + type: 'doc', + id: 'mentee-viewchatmessages', // document ID + label: 'Viewing Chat Messages', // sidebar label }, { type: 'doc', diff --git a/src/docusaurus/sidebarsUserservices.js b/src/docusaurus/sidebarsUserservices.js new file mode 100644 index 0000000..80f2c37 --- /dev/null +++ b/src/docusaurus/sidebarsUserservices.js @@ -0,0 +1,181 @@ +/** + * Creating a sidebar enables you to: + - create an ordered group of docs + - render a sidebar for each doc of that group + - provide next/previous navigation + + The sidebars can be generated from the filesystem, or explicitly defined here. + + Create as many sidebars as you want. + */ + +// @ts-check + +/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ +const sidebars = { + // By default, Docusaurus generates a sidebar from the docs folder structure + tutorialSidebar: [ + + { + type: 'category', + label: 'Getting Started', + items: [ + { + type: 'doc', + id: 'intro', // document ID + label: 'Introduction', // sidebar label + }, + { + type: 'doc', + id: 'technicalarchitecture', // document ID + label: 'Architecture', // sidebar label + }, + { + type: 'doc', + id: 'key-capabilities', // document ID + label: 'Key Capabilities', // sidebar label + }, + ] + }, + + { + type: 'doc', + id: 'settingup-overview', + label: 'Hosting and Customizing Your Instance', + }, + + { + type: 'category', + label: 'Using the Application', + items: [ + { + type: 'doc', + id: 'using-the-application', // document ID + label: 'About the Application', // sidebar label + }, + { + type: 'doc', + id: 'gettingstarted', // document ID + label: 'Getting Started with User Services', // sidebar label + }, + { + type: 'doc', + id: 'register', // document ID + label: 'Registering New Users', // sidebar label + }, + { + type: 'doc', + id: 'login', // document ID + label: 'Logging in', // sidebar label + }, + + { + type: 'doc', + id: 'forgotpwd', + label: 'Resetting Your Password', + }, + + { + type: 'doc', + id: 'delete', + label: 'Deleting the Account', + }, + + { + type: 'doc', + id: 'profile', // document ID + label: 'Updating Your Profile', // sidebar label + }, + ] + }, + + + { + type: 'category', + label: 'Tenant Management', + items: [ + +{ + type: 'doc', + id: 'abouttenants', + label: 'About Tenants', + }, +{ + type: 'doc', + id: 'configuretenants', + label: 'Creating and Configuring Tenants', + }, + ] +}, + + +{ + type: 'category', + label: 'Managing Users and Roles', + items: [ + {type: 'doc', + id: 'createuser', // document ID + label: 'Creating a User', // sidebar label + }, + + { + type: 'doc', + id: 'deleteuser', // document ID + label: 'Deleting a User', // sidebar label + }, + + { + type: 'doc', + id: 'userroles', // document ID + label: 'Managing User Roles', // sidebar label + }, + { + type: 'doc', + id: 'permissions', // document ID + label: 'Permission Hierarchy', // sidebar label + }, + + { + type: 'doc', + id: 'apireference', // document ID + label: 'API Reference', // sidebar label + }, + + ] + }, + + { + type: 'category', + label: 'Core Features and Configuration', + items: [ + + { + type: 'doc', + id: 'bulkuserupload', + label: 'Bulk User Upload', + }, + + { + type: 'doc', + id: 'tenantmgmt', + label: 'Setting Up Multi-tenant Organizations', + }, + + { + type: 'doc', + id: 'orgmgmt', + label: 'Manage Organizations', + }, + + {type: 'doc', + id: 'notification', // document ID + label: 'Understanding Notification workflows', // sidebar label + }, + ] + }, + + + ], + }; + + module.exports = sidebars; \ No newline at end of file diff --git a/src/docusaurus/userservices/abouttenants.mdx b/src/docusaurus/userservices/abouttenants.mdx new file mode 100644 index 0000000..1874b25 --- /dev/null +++ b/src/docusaurus/userservices/abouttenants.mdx @@ -0,0 +1,34 @@ +# Overview + + +A tenant represents a customer or a company on a SaaS platform associated with a unique domain name and tenant ID. + +Tenants are logically distinct from one another in terms of their data, users, permissions, settings, and configurations. +Tenants enable companies to share infrastructure and databases across different organizations, making it more secure and cost-effective. + +Types of Tenancy: + +1. Single-Tenant architecture: Every customer gets a dedicated database and application instance. + + +2. Multi-tenant architecture: All customers share the same application and database; however each customer will have their own isolated data and + configuration. + +A multi-tenant architecture uses a single instance of the software application to serve multiple customers/tenants. +In this model, all tenants share common features like security, business logic, and resource management. +Since resources are shared among multiple tenants, they are more cost effective and scalable. + +Within a tenant, the organization structure exists. +For example, each tenant can have a number of organizations, like Org A, Org B, Org C, and so on, under it. + The tenants will have their own data and configurations within the system. + + ![](media/multitenant.png) + + 1. Data Segregation: Uses a shared database; however, the data is segregated at the application or database layer using tenant IDs. + Data is not shared across tenants. +2. Every user can be associated with multiple organizations that are part of the same tenant. + +3. Users who are part of one organization within a tenant can access data from other organizations through organizational policies. + + + diff --git a/src/docusaurus/userservices/apireference.mdx b/src/docusaurus/userservices/apireference.mdx new file mode 100644 index 0000000..e69de29 diff --git a/src/docusaurus/userservices/bulkuserupload.mdx b/src/docusaurus/userservices/bulkuserupload.mdx new file mode 100644 index 0000000..e69de29 diff --git a/src/docusaurus/userservices/configservice.mdx b/src/docusaurus/userservices/configservice.mdx new file mode 100644 index 0000000..e69de29 diff --git a/src/docusaurus/userservices/configuretenants.mdx b/src/docusaurus/userservices/configuretenants.mdx new file mode 100644 index 0000000..3f68c60 --- /dev/null +++ b/src/docusaurus/userservices/configuretenants.mdx @@ -0,0 +1,38 @@ +# Creating and Configuring Tenants + +To set up a multi-tenant architecture, adopters can: + +1. Set up the application using the microservices. + +2. Create multiple organizations and assign administrators for each organization. + + + + + + + + + + + + + + + + + + + + +
        RoleResponsibilities
        Super AdminCreate and manage users and organizations for any tenants within the system.
        Tenant AdminCreate and manage users for all organizations belonging to a particular tenant.
        Organization AdminCreate and manage users for the organization they belong to. +
        + + +## Tenant isolation and multi-tenancy considerations + + + +## API endpoints, UI steps, and examples + + diff --git a/src/docusaurus/userservices/corefeatures.mdx b/src/docusaurus/userservices/corefeatures.mdx new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/src/docusaurus/userservices/corefeatures.mdx @@ -0,0 +1 @@ + diff --git a/src/docusaurus/userservices/createuser.mdx b/src/docusaurus/userservices/createuser.mdx new file mode 100644 index 0000000..e69de29 diff --git a/src/docusaurus/userservices/delete.mdx b/src/docusaurus/userservices/delete.mdx new file mode 100644 index 0000000..e69de29 diff --git a/src/docusaurus/userservices/deleteuser.mdx b/src/docusaurus/userservices/deleteuser.mdx new file mode 100644 index 0000000..e69de29 diff --git a/src/docusaurus/userservices/forgotpwd.mdx b/src/docusaurus/userservices/forgotpwd.mdx new file mode 100644 index 0000000..a0056b5 --- /dev/null +++ b/src/docusaurus/userservices/forgotpwd.mdx @@ -0,0 +1,16 @@ +# Resetting a Forgotten Password + + +While logging in, if you don't remember your password you can change it. + +To reset your password, do as follows: + +1. On the Login page, click the Forgot Password? link. +2. Enter your Email or Username or the Mobile number. +3. Enter the New Password. + +![](media/forgotpassword.png) + +4. Re-enter the new password in the Confirm New Password text box. +3. Click Send OTP. An OTP is sent to your registered email ID. +4. Enter the OTP to log in to the Home page. diff --git a/src/docusaurus/userservices/gettingstarted.mdx b/src/docusaurus/userservices/gettingstarted.mdx new file mode 100644 index 0000000..e69de29 diff --git a/src/docusaurus/userservices/intro.mdx b/src/docusaurus/userservices/intro.mdx new file mode 100644 index 0000000..72cf365 --- /dev/null +++ b/src/docusaurus/userservices/intro.mdx @@ -0,0 +1,14 @@ +# Overview + +Using the user services building block, organizations and individuals can effectively streamline the +user management and organization management capabilities. This includes user registration, the login process, multi-tenancy, role-based access, +profile management, permissions, and secure access to the applications. + + +## Multi-tenant Architecture + +Additionally, Elevate capabilities are designed to be deployed on SaaS platform offering more cost-effective, secure, and scalable +system to accommodate more tenants or organizations. +A multi-tenant architecture uses a single instance of the software application to serve multiple customers/tenants. In this model, all tenants share common features like security, business logic, and resource management. +This model uses a single shared database instance for all tenants. Data is segregated at the application or database layer using tenant IDs. Backend DB is same across all tenants. Within a tenant, the organization structure exists. For example, each tenant can have a number of organizations like Org1, Org2, Org3, and so on under it. The tenants will have their own data and configurations within the system. + diff --git a/src/docusaurus/userservices/key-capabilities.mdx b/src/docusaurus/userservices/key-capabilities.mdx new file mode 100644 index 0000000..05cf48f --- /dev/null +++ b/src/docusaurus/userservices/key-capabilities.mdx @@ -0,0 +1,48 @@ +# Key Capabilities + +Organizations need strong authentication methods to prevent unauthorized access to applications and data. +Using the user services building block, organizations and individuals can effectively streamline the +administrative processes. This includes user registration, the login process, multi-tenancy, role-based access, +profile management, permissions, and secure access to the applications. + + +## Key Features + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        FeaturesDescription
        User RegistrationA customizable and user-friendly registration form to gather users' information.
        Reset PasswordYou can reset a forgotten password and also change the password when you wish to
        Profile UpdateUpdate your personal information or contact details.
        Role-based accessProvide controlled access to the applications based on the user's role.
        Access Control PoliciesHelps organizations to set up user access policies and also modify them when required.
        PermissionsGrant permission based on the user's role.
        Multi-tenancyManage users belonging to different organizations when using SaaS applications.
        diff --git a/src/docusaurus/userservices/login.mdx b/src/docusaurus/userservices/login.mdx new file mode 100644 index 0000000..0025c42 --- /dev/null +++ b/src/docusaurus/userservices/login.mdx @@ -0,0 +1,16 @@ +# Logging in to the Home Page + +After you register, you can log in to access the Home page. + +To log in to the Home page, do as follows: + +1. Enter your e-mail or mobile number or user name. + +2. Enter your password. + + ![](media/login.png) + +3. Click Login. The Home page appears. + + + \ No newline at end of file diff --git a/src/docusaurus/userservices/media/forgotpassword.png b/src/docusaurus/userservices/media/forgotpassword.png new file mode 100644 index 0000000..6349468 Binary files /dev/null and b/src/docusaurus/userservices/media/forgotpassword.png differ diff --git a/src/docusaurus/userservices/media/login-register.png b/src/docusaurus/userservices/media/login-register.png new file mode 100644 index 0000000..78252b0 Binary files /dev/null and b/src/docusaurus/userservices/media/login-register.png differ diff --git a/src/docusaurus/userservices/media/login.png b/src/docusaurus/userservices/media/login.png new file mode 100644 index 0000000..287df59 Binary files /dev/null and b/src/docusaurus/userservices/media/login.png differ diff --git a/src/docusaurus/userservices/media/multitenant.png b/src/docusaurus/userservices/media/multitenant.png new file mode 100644 index 0000000..414b814 Binary files /dev/null and b/src/docusaurus/userservices/media/multitenant.png differ diff --git a/src/docusaurus/userservices/media/registerform.png b/src/docusaurus/userservices/media/registerform.png new file mode 100644 index 0000000..a9a7c25 Binary files /dev/null and b/src/docusaurus/userservices/media/registerform.png differ diff --git a/src/docusaurus/userservices/notification.mdx b/src/docusaurus/userservices/notification.mdx new file mode 100644 index 0000000..e69de29 diff --git a/src/docusaurus/userservices/orgmgmt.mdx b/src/docusaurus/userservices/orgmgmt.mdx new file mode 100644 index 0000000..686d608 --- /dev/null +++ b/src/docusaurus/userservices/orgmgmt.mdx @@ -0,0 +1 @@ +# About Organizations \ No newline at end of file diff --git a/src/docusaurus/userservices/permissions.mdx b/src/docusaurus/userservices/permissions.mdx new file mode 100644 index 0000000..e69de29 diff --git a/src/docusaurus/userservices/prerequisites.mdx b/src/docusaurus/userservices/prerequisites.mdx new file mode 100644 index 0000000..6059b91 --- /dev/null +++ b/src/docusaurus/userservices/prerequisites.mdx @@ -0,0 +1 @@ +# Prerequisites diff --git a/src/docusaurus/userservices/profile.mdx b/src/docusaurus/userservices/profile.mdx new file mode 100644 index 0000000..0e0815e --- /dev/null +++ b/src/docusaurus/userservices/profile.mdx @@ -0,0 +1 @@ +# Updating Your Profile diff --git a/src/docusaurus/userservices/quickstart.mdx b/src/docusaurus/userservices/quickstart.mdx new file mode 100644 index 0000000..179f6b7 --- /dev/null +++ b/src/docusaurus/userservices/quickstart.mdx @@ -0,0 +1 @@ +# Quickstart \ No newline at end of file diff --git a/src/docusaurus/userservices/register.mdx b/src/docusaurus/userservices/register.mdx new file mode 100644 index 0000000..d53444e --- /dev/null +++ b/src/docusaurus/userservices/register.mdx @@ -0,0 +1,70 @@ +import Admonition from '@theme/Admonition'; + +# Registering Users + +After receiving the application's link, you must register to create a user account using the registration form. +This registration form is configurable at the tenant level. + +

        + + + + The registration form shown here is a sample form for educational purposes. + You can add or remove fields based on your organization's specific needs. + To learn more about how to add or remove fields, see Create Entity Types and Entities. + + +

        + + +From the Login page, click Register. The registration form appears. + +![](media/login-register.png) + + +To register a user do as follows: + +1. Enter your details: + + * First Name + * Last Name + * Username + * Email +

        + +

        Enter a valid email ID.

        + +

        + + * Contact Number + * Password + +

        + +

        Your password must be at least 8 characters long and include uppercase, lowercase, number, and special character.

        + +

        + + * Re-enter the password in the Confirm Password text box. + +2. Select the appropriate role from the student dropdown. You can select more than one role. + +3. Select the Sub-Role. This field does not appear for Parents Role. + +4. Enter the Registration code. + +5. Enter the Udise code. Click on Fetch to get the state, district, block, cluster, and school details. + + ![](media/registerform.png) + + +6. Click Send OTP. An OTP is sent to your registered email ID. + +7. Enter the OTP. The Home page appears. +

        + +

        To receive a new OTP, click Resend OTP.

        + +

        + + diff --git a/src/docusaurus/userservices/settingup-overview.mdx b/src/docusaurus/userservices/settingup-overview.mdx new file mode 100644 index 0000000..e73b7ff --- /dev/null +++ b/src/docusaurus/userservices/settingup-overview.mdx @@ -0,0 +1 @@ +# Hosting and Customizing User Services \ No newline at end of file diff --git a/src/docusaurus/userservices/setuptenantsandorgs.mdx b/src/docusaurus/userservices/setuptenantsandorgs.mdx new file mode 100644 index 0000000..e69de29 diff --git a/src/docusaurus/userservices/technicalarchitecture.mdx b/src/docusaurus/userservices/technicalarchitecture.mdx new file mode 100644 index 0000000..e69de29 diff --git a/src/docusaurus/userservices/tenantmgmt.mdx b/src/docusaurus/userservices/tenantmgmt.mdx new file mode 100644 index 0000000..ab7da61 --- /dev/null +++ b/src/docusaurus/userservices/tenantmgmt.mdx @@ -0,0 +1,5 @@ +# Multi-tenant architecture + +A multi-tenant architecture uses a single instance of the software application to serve multiple customers/tenants. +In this model, all tenants share common features like security, business logic, and resource management. + Since resources are shared among multiple tenants, they are more cost effective and scalable. \ No newline at end of file diff --git a/src/docusaurus/userservices/userrolemgmt.mdx b/src/docusaurus/userservices/userrolemgmt.mdx new file mode 100644 index 0000000..e69de29 diff --git a/src/docusaurus/userservices/userroles.mdx b/src/docusaurus/userservices/userroles.mdx new file mode 100644 index 0000000..e69de29 diff --git a/src/docusaurus/userservices/using-the-application.mdx b/src/docusaurus/userservices/using-the-application.mdx new file mode 100644 index 0000000..9c7d92d --- /dev/null +++ b/src/docusaurus/userservices/using-the-application.mdx @@ -0,0 +1 @@ +# About User Services \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/_elevate.mdx b/src/docusaurus/versioned_docs/version-3.1/_elevate.mdx new file mode 100644 index 0000000..771c6f9 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/_elevate.mdx @@ -0,0 +1 @@ +{props.mentored="Elevate"} \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/_formfieldscustomizability.mdx b/src/docusaurus/versioned_docs/version-3.1/_formfieldscustomizability.mdx new file mode 100644 index 0000000..7a45bd5 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/_formfieldscustomizability.mdx @@ -0,0 +1,5 @@ +import Admonition from '@theme/Admonition'; + + +The information that you need to provide can vary based on how this feature is set up by your organization. + \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/_joinsessionstep-portal.mdx b/src/docusaurus/versioned_docs/version-3.1/_joinsessionstep-portal.mdx new file mode 100644 index 0000000..3e7bb36 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/_joinsessionstep-portal.mdx @@ -0,0 +1,9 @@ +On the dialog displaying the information about the meeting platform, do one of the following actions: + +* If the meeting platform is BigBlueButton, click **Join**. The BigBlueButton window appears on your web browser. +* If the meeting platform is Google Meet, click **Join**. The Google Meet window appears. +* If the meeting platform is WhatsApp, click **Join**. The meeting appears on WhatsApp. +* If the meeting platform is Zoom, do one of the following actions: + + * Click **Join**. The Zoom meeting window appears. + * Click Copy ![](media/copyicon.png) to copy the **Meeting ID** and **Password** and paste it on the Zoom app to join the meeting. \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/_login.mdx b/src/docusaurus/versioned_docs/version-3.1/_login.mdx new file mode 100644 index 0000000..cd362ca --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/_login.mdx @@ -0,0 +1,9 @@ +import PartialExample from './_mentored.mdx'; +import Admonition from '@theme/Admonition'; + +
      4. Open and select Login.
        5. +
      5. Enter your Email and Password.
        6. + +

        Enter the correct email ID and password to access the Home page. Passwords are case-sensitive.

        +         +
      6. Complete the reCAPTCHA verification if required.
        7. diff --git a/src/docusaurus/versioned_docs/version-3.1/_mentored.mdx b/src/docusaurus/versioned_docs/version-3.1/_mentored.mdx new file mode 100644 index 0000000..6193591 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/_mentored.mdx @@ -0,0 +1 @@ +{props.mentored="Mentor"} \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/_resetpassword.mdx b/src/docusaurus/versioned_docs/version-3.1/_resetpassword.mdx new file mode 100644 index 0000000..dfece27 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/_resetpassword.mdx @@ -0,0 +1,16 @@ +import PartialExample from './_mentored.mdx'; +import Admonition from '@theme/Admonition'; + + +1. On the Login page, click the Forgot password link. +2. Enter your Email and the new password. +3. Click Validate OTP. +4. Complete the reCAPTCHA verification if required. +5. Click Generate OTP. An OTP is sent to your registered email ID. +7. Enter the OTP. +

        + +

        To receive a new OTP, click the Resend OTP link.

        + +

        +8. Click Verify and login to log in to the Home page. diff --git a/src/docusaurus/versioned_docs/version-3.1/_searchsession.mdx b/src/docusaurus/versioned_docs/version-3.1/_searchsession.mdx new file mode 100644 index 0000000..3cf16ee --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/_searchsession.mdx @@ -0,0 +1,32 @@ +import Admonition from '@theme/Admonition'; + +To find upcoming sessions, enter a keyword such as the session title or mentor's name in the **Search** box and press **Enter**. The search results appear as session tiles. + +
        +To refine your search results, you can also search for sessions based on a specific category. Click here for the following actions: + +1. To specify the search category, click the **Search** box and select a search category such as **Mentor name**. + +2. Enter the search keyword. Based on the specified search category, the search results appear as session tiles. + + ![](media/portal-searchsessions.png) + +
        + +**From the search results, you can find the respective session using the following ways:** + +* Viewing the search results on different pages by clicking the Next or Previous buttons. +* Changing the number of search results listed on the page using the Items per page dropdown. +* Applying filters as follows: + + * Click on Filter. + * Select one or more filters and click Apply. +

        + +

        To clear filters, do one of the following actions:

        +
          +
        • Clear the filter checkbox.
          • +
        • Click Clear all to clear all the applied filters.
          • +
        + +

        \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/_sessionbulkuploadtable.mdx b/src/docusaurus/versioned_docs/version-3.1/_sessionbulkuploadtable.mdx new file mode 100644 index 0000000..6a07137 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/_sessionbulkuploadtable.mdx @@ -0,0 +1,68 @@ +import Admonition from '@theme/Admonition'; + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        DetailsActions
        TitleYou must enter the topic for the session.
        DescriptionYou must provide further details on the session.
        Type

        You must specify the type of session as Private or Public.

        You cannot change the session type after publishing the session.

        Mentor

        You must enter the email ID of the mentor to whom you want to assign the session.

        After publishing the session, you cannot assign the session to a different mentor.

        Mentees

        To invite mentees to a session, enter the email IDs of one or more mentees.

        • It is optional to invite mentees to a Public session.
        • After a session is published, you can update the list of invited mentees by adding or removing mentees.
        • To facilitate one-on-one mentoring, you can set up Private sessions consisting of an invited mentee.

        The number of invited mentees should be within the session enrollment limit.

        DateYou must enter the scheduled date in DD-MM-YYYY format.
        Time Zone

        You must specify the time zone as IST or UTC.

        On the application, the time displayed is IST.

        Time

        As per the specified time zone, you must enter the scheduled start time using a 24-hour clock format. For example, to schedule a session at 5 pm, specify the time as 17:00 Hrs.

        While scheduling a session, ensure that the mentor does not have another session scheduled during the same time.

        You cannot assign back-to-back sessions to a mentor. For example, if a mentor is assigned a session from 3pm to 4pm, you cannot assign another session at 4pm.

        Duration

        You must enter the duration of the session in minutes.

        • Enter only numerical values. For example: 60.
        • The session duration should be at least 30 minutes.

        Recommended ForYou must specify one or more target mentees for the session. For example: Teachers, Block education officer
        CategoriesYou must specify one or more categories to which the session topic belongs. For example, if the session topic is Communication Skills Training, the categories can be Communication, Life skills.
        MediumYou must enter the language using which information is communicated during the session.
        Meeting Platform

        Specify the meeting platform. The supported meeting platforms are as follows:

        • BigBlueButton
        • Google Meet
        • WhatsApp
        • Zoom

        If you have not specified a meeting platform, BigBlueButton is set as the default platform.

        Meeting LinkFor meeting platforms other than BigBlueButton, copy and paste the meeting link.
        Meeting PasscodeIf the meeting platform is Zoom, copy and paste the meeting passcode.
        \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/_shiksha.mdx b/src/docusaurus/versioned_docs/version-3.1/_shiksha.mdx new file mode 100644 index 0000000..9a61529 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/_shiksha.mdx @@ -0,0 +1 @@ +{props.shiksha="ShikshaLokam"} diff --git a/src/docusaurus/versioned_docs/version-3.1/_signup.mdx b/src/docusaurus/versioned_docs/version-3.1/_signup.mdx new file mode 100644 index 0000000..6994aca --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/_signup.mdx @@ -0,0 +1,39 @@ +import PartialExample from './_mentored.mdx'; +import Admonition from '@theme/Admonition'; + +1. Open and click Sign up. + +2. Enter your details: + + * Name + * Email +

        + +

        Enter a valid email ID.

        + +

        + * Password + +3. Click Validate OTP. + +4. Complete the reCAPTCHA verification if required. + +5. Click Generate OTP. An OTP is sent to your registered email ID. + +6. Enter the OTP. +

        + +

        To receive a new OTP, click Resend OTP.

        + +

        + +7. Do the following actions: + + * To read the privacy policy, click the Privacy Policy link. + * To read the terms of service, click the Terms of Service link. + +8. Select the checkbox to agree to the terms of service and policy settings. + +9. Click Verify and login. + +10. To access the Home page and other features, create your profile. \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/_version.mdx b/src/docusaurus/versioned_docs/version-3.1/_version.mdx new file mode 100644 index 0000000..3af3855 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/_version.mdx @@ -0,0 +1 @@ +{props.version="2.5"} \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/aboutorganizationadministrator.mdx b/src/docusaurus/versioned_docs/version-3.1/aboutorganizationadministrator.mdx new file mode 100644 index 0000000..ae20443 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/aboutorganizationadministrator.mdx @@ -0,0 +1,39 @@ +import SignUp from './_signup.mdx'; +import BurgerMenu from './media/burgermenu-icon.png' +import Admonition from '@theme/Admonition'; + +# Organization Administrator + +The organization administrator can perform the following actions: + +* Upload the list of users with preassigned roles to the application. +* Manage users' requests to become a mentor. + +You can access the Organization Administrator account using one of the following ways: + +* If you are signing up for the first time, use the application's link included in the email invite. +* If you are a registered user, you will receive an email notification after being assigned the role of an Organization Administrator. After logging in, you can access the **Workspace** page. + +

        To access your Home page and other application features, your profile must be complete.

        +         + + ![](media/orgadminpage.png) + +## Signing up + +After receiving the application's link, you must sign up to create an account. + +**To sign up, do as follows:** + + + +### Logging out + +To log out, do one of the following actions: + +* Select Logout from the Application menu. + +* Go to the Application menu and select Logout. + + + diff --git a/src/docusaurus/versioned_docs/version-3.1/aboutsessionmanager.mdx b/src/docusaurus/versioned_docs/version-3.1/aboutsessionmanager.mdx new file mode 100644 index 0000000..b39dbda --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/aboutsessionmanager.mdx @@ -0,0 +1,39 @@ +import SignUp from './_signup.mdx'; +import Admonition from '@theme/Admonition'; + +# Session Manager + +Session managers can gain oversight of the mentoring program at an organization by: + +* Creating (Public or Private) sessions. +* Assigning the sessions to respective mentors. The assigned sessions are hosted by mentors during the scheduled time. +* Inviting mentees to the sessions. +* Conducting session management activities such as updating the session and meeting details and tracking the session's status and mentee enrollments. + +You can access the Session Manager account using one of the following ways: + +* If you are signing up for the first time, use the application's link included in the email invite. +* If you are a registered user, you will receive an email notification after being assigned the role of a Session Manager. After logging in, you can access the **Workspace** page. + + +

        To access your Home page and other application features, your profile must be complete.

        +         + + ![](media/sessionmanagerpage.png) + +## Signing up + +After receiving the application's link, you must sign up to create an account. + +**To sign up, do as follows:** + + + +### Logging out + +To log out, do one of the following actions: + +* Select Logout from the Application menu. + +* Go to the Application menu ![burger menu](media/burgermenu-icon.png) and select Logout. + diff --git a/src/docusaurus/versioned_docs/version-3.1/accountloginactivity.mdx b/src/docusaurus/versioned_docs/version-3.1/accountloginactivity.mdx new file mode 100644 index 0000000..2a05b08 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/accountloginactivity.mdx @@ -0,0 +1,37 @@ +import Admonition from '@theme/Admonition'; +import BurgerMenu from './media/burgermenu-icon.png' + +# Viewing the Account Login Activity + +On the Login activity page, you can view the following: + +* The devices from which you have logged in to your account. +* The browsers on your device from which you logged in to your account. +* The details of your login activity such as: + * The last login time. + * The device or browser from which: + * You are currently accessing your account. + * You have logged out of your account. + * Your login session has expired. + +To access the Login activity page, do one of the following actions: + + * Select Login activity from the Application menu. + * Go to the Application menu and select Login activity. + +![](media/loginactivity.png) + +## Logging out + +On the Login activity page, if you notice a device or a browser that is unfamiliar or not in use, you can click **Logout**. + +

        + +

        You can change the number of devices or browsers listed on the page using the Items per page dropdown.

        + +

        + + + + + diff --git a/src/docusaurus/versioned_docs/version-3.1/api-entitytypeandentity.mdx b/src/docusaurus/versioned_docs/version-3.1/api-entitytypeandentity.mdx new file mode 100644 index 0000000..d2dab26 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/api-entitytypeandentity.mdx @@ -0,0 +1,88 @@ +import PartialExample from './_mentored.mdx'; +import Admonition from '@theme/Admonition'; + +# Create Entity Types and Entities + +In service, entity types refer to the properties of sessions or mentors. The labels assigned to entity types appear as fields on the profile and session creation pages of the application. + +The types of fields are as follows: + +* Text fields: Users can add single or multiple lines of text. + +* Select fields: Contains a range of options for user to choose from. These are of two types: + + * Single-select fields: Users are allowed to select only one option. + + * Multi-select fields: Users can select multiple options. + +For entity types containing a fixed range of options, each option is known as an entity. The labels assigned to entities appear as options in the single-select or multi-select fields of session or profile creation pages. + +For example: + + * For a session entity type such as Category, the entities include Communication and Life Skills. + + * For a session entity type such as Language, the entities include English and Hindi. + + +

        For a given entity type, each organization can define a set of domain-specific entities.

        For example, for an entity type such as Role, the entities defined in the educational domain would include teacher and headmaster. Whereas, the entities defined in the healthcare domain would include physician and specialist.

        +         + +## Create and Manage Entity Types + + + + + + + + + + + + + + + + + + + + + + + + + + +
        API ReferenceDescription
        Organization Administrator Login

        To carry out administrative functions in the back end such as creating entity types, organization administrators must do the following:

        +
        1. After receiving the application's link through email, organization administrators must sign up on the application. See the Organization Administrator section to learn more.
        2. Using APIs, log in to generate an access_token.
        Create Entity Types

        System administrators or organization administrators can create new entity types to achieve the following:

        • Define domain-specific properties for sessions or mentors.
        • Add new text fields, and single-select or multi-select fields on the profile or session creation pages.
        • Set new default rules for entity types containing a fixed range of entities.

        Only system administrators can set the entity type as searchable and filterable on the application.

        Get Entity TypesTo update or delete entity types, system administrators or organization administrators can obtain the details of entity types such as the ID and value.
        Update Entity Types

        System administrators or organization administrators can modify the existing entity types as per the organization's requirements.

        The entity types updated by an organization administrator apply only to their specific organization.

        Delete Entity Types

        System administrators or organization administrators can delete entity types that are no longer needed.

        The entity types deleted by an organization administrator are applicable only to their specific organization.

        + +## Create and Manage Entities + + + + + + + + + + + + + + + + + + + + + + + + + + +
        API ReferenceDescription
        Organization Administrator Login

        To carry out administrative functions in the back end such as creating entities, organization administrators must do the following:

        +
        1. After receiving the application's link through email, organization administrators must sign up on the application. See the Organization Administrator section to learn more.
        2. Using APIs, log in to generate an access_token.
        Create Entities

        System administrators or organization administrators can create new entities to achieve the following:

        • Define new domain-specific entities and map them to an entity type.
        • Add new options to the single-select or multi-select fields of session or profile creation pages.
        Get EntitiesTo update or delete entities, system administrators or organization administrators can obtain the details of entities such as ID and value.
        Update Entities

        System administrators or organization administrators can modify the existing entities as per the organization's requirements.

        The entities updated by an organization administrator apply only to their specific organization.

        Delete Entities

        System administrators or organization administrators can delete entities that are no longer needed.

        The entities deleted by an organization administrator are applicable only to their specific organization.

        diff --git a/src/docusaurus/versioned_docs/version-3.1/api-overview.mdx b/src/docusaurus/versioned_docs/version-3.1/api-overview.mdx new file mode 100644 index 0000000..a20f630 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/api-overview.mdx @@ -0,0 +1,26 @@ +import Admonition from '@theme/Admonition'; +import PartialExample from './_mentored.mdx'; + +# Overview + +

        + +

        See About Organizations to learn more about implementing the multi-tenant architecture using the User service.

        + +

        + +Using the REST APIs of service, organizations can do the following: + +* Configure policies. + +* Create and manage entity types and entities on the session and profile creation pages. + +* Set default rules. + +## Accessing the API Collection + +To access the APIs on Postman, do any one of the following actions: + +* Import the JSON and environment file from https://github.com/ELEVATE-Project/mentoring/tree/master/src/api-doc + +* Import the raw URL from https://raw.githubusercontent.com/ELEVATE-Project/mentoring/master/src/api-doc/MentorED-Mentoring.postman_collection.json \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/api-setpolicies.mdx b/src/docusaurus/versioned_docs/version-3.1/api-setpolicies.mdx new file mode 100644 index 0000000..b158077 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/api-setpolicies.mdx @@ -0,0 +1,36 @@ +import Admonition from '@theme/Admonition'; +import PartialExample from './_mentored.mdx'; + +# Set Policies for an Organization + +Organization administrators can set policies for the following aspects: + + * Visibility policies: Manage whether their sessions, mentors, or mentees are accessed by other organizations. + + * External visibility policies: Manage whether their mentees can access sessions, mentors, or mentees of other organizations. + +To learn more about the types of policies that can be configured, see [Policy Architecture](policyarchitecture#policy-architecture). + + + + + + + + + + + + + + + + + + + + + + +
        API ReferenceDescription
        Organization Administrator Login

        To carry out administrative functions in the back end such as setting policies, organization administrators must do the following:

        +
        1. After receiving the application's link through email, organization administrators must sign up on the application.
        2. Using APIs, log in to generate an access_token.
        Get Organization DetailsBefore setting policies, organization administrators must obtain organization's details such as organization ID.
        Set Policies

        Organization administrators can do any one of the following actions:

        • Set policies for the organization.
        • Modify the organization's existing policies.
        Get PoliciesOrganization administrators can obtain the policies configured for the organization.
        \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/api-setrules.mdx b/src/docusaurus/versioned_docs/version-3.1/api-setrules.mdx new file mode 100644 index 0000000..d1afbd7 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/api-setrules.mdx @@ -0,0 +1,49 @@ +import PartialExample from './_mentored.mdx'; +import Admonition from '@theme/Admonition'; + + +# Set Rules for Mentor and Session Discovery + +Organization administrators can set rules or conditions based on which users can discover mentors or sessions on the application according to the rules set. + +Examples: + +* By setting rules that match users with mentors based on their preferred languages, users can view only the mentor profiles that match their languages of preference. + +* By setting rules that match users with sessions based on their preferred languages, organizations can achieve any one of the following: + + * Users can view sessions where the language of instruction matches their languages of preference. + + * Mentees can view sessions hosted by a mentor who match their languages of preference. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        API ReferenceDescription
        Organization Administrator Login

        To carry out administrative functions in the back end such as setting rules for mentor and session discovery, organization administrators must do the following:

        +
        1. After receiving the application's link through email, organization administrators must sign up on the application. See the Organization Administrator section to learn more.
        2. Using APIs, log in to generate an access_token.
        Get Entity TypesBefore setting rules for mentor and session discovery, organization administrators must obtain list of entity types associated with mentors and sessions.
        Set Rules for Mentor and Session DiscoveryOrganization administrators can set rules for mentor and session discovery using entity types that contain a fixed range of entities.
        Get RulesTo update or delete rules for an organization, the organization administrator can obtain the list of rules and their IDs.
        Update RulesOrganization administrators can modify the existing rules.
        Delete RulesOrganization Administrators can delete rules that are no longer required.
        \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/apidocumentation.mdx b/src/docusaurus/versioned_docs/version-3.1/apidocumentation.mdx new file mode 100644 index 0000000..54ab9e2 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/apidocumentation.mdx @@ -0,0 +1,19 @@ +# API Documentation + +If you wish to integrate a custom application, you need to understand how to use the Application Programming Interfaces exposed by the platform. To learn about APIs, see the following topics: + +* [API Documentation](https://github.com/ELEVATE-Project/mentoring/wiki/API-Documentation) + +* [API Request Flow](https://github.com/ELEVATE-Project/mentoring/wiki/API-Request-Flow) + +## Data Caching and Storage + +See the following links to learn more about temporary and persistent data storage: + +- [Caching](https://github.com/ELEVATE-Project/mentoring/wiki/Caching---Redis-&-Internal): Click this link to learn how to store data temporarily using the caching services available on the platform. + +- [Database Design](databasedesign): Go through this resource to get a better understanding of how the platform database is structured. + +- [Migration](https://github.com/ELEVATE-Project/mentoring/wiki/Migration): Use this resource to understand how to import or migrate data from other application. + + diff --git a/src/docusaurus/versioned_docs/version-3.1/bulkupload-invalidsession.mdx b/src/docusaurus/versioned_docs/version-3.1/bulkupload-invalidsession.mdx new file mode 100644 index 0000000..c5fbbad --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/bulkupload-invalidsession.mdx @@ -0,0 +1,63 @@ +import Admonition from '@theme/Admonition'; + +# Troubleshooting Invalid Sessions + +If session managers have received invalid messages on the session status CSV file after uploading sessions to the platform, they can use this guide to make the necessary corrections and upload the file again. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Invalid Status MessageErrors
        Mandatory fields <name of the column> not filled

        You have not provided one or more mandatory information specified in the invalid message. For example: If you have not entered the session date, you will receive the invalid message 'Mandatory fields date not filled'.

        Invalid <name of the column>

        You have entered the information in the wrong column or in the incorrect format. Here are some examples:

        • If you enter the mentee's email ID in the Mentor column, the invalid message would be Invalid mentor email.
        • If the date entered is wrong or in the incorrect format, the invalid message would be Invalid date.
        User not foundYou have added a non-existent mentor or mentee.
        Below minimum session timeYou must create a session with a session duration of at least 30 minutes.
        Only <number> mentees are allowedThe number of invited mentees exceeded the session enrollment limit.
        Invalid row actionYou have entered Create in the Action column and have specified an existing session ID in the ID column.
        Session not foundWhile editing or deleting sessions, you have entered a non-existent session ID.
        Cannot edit mentor and typeYou cannot edit the session type or the mentor after publishing the session.
        Cannot delete live sessionWhile deleting sessions, you have added the session ID of an ongoing (live) session.
        Session creation limit exceeded for given mentor

        You will receive this error due to the following reasons:

        • Duplicate sessions: The mentor is already assigned a session during the specified time.
        • Successive sessions: If a mentor is assigned a session from 3 pm to 4 pm, you cannot assign another session starting from 4 pm.
        + + +

        To look up guidelines on entering the session information in the bulk upload CSV file, see the bulk upload table in any one of the following sections:

        + +         + + + diff --git a/src/docusaurus/versioned_docs/version-3.1/bulkupload.mdx b/src/docusaurus/versioned_docs/version-3.1/bulkupload.mdx new file mode 100644 index 0000000..94252e5 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/bulkupload.mdx @@ -0,0 +1,51 @@ +import Admonition from '@theme/Admonition'; + +# Uploading Users to the Application + +Using a CSV file, organization administrators can upload the list of users to the application to: + +* Invite new users with preassigned roles (mentor and mentee). + +* Invite new users (mentor or mentee) with Session Manager privileges. + +* Invite registered users to the organization. After uploading the list of registered users, they are assigned an organization. + +* Allow registered users to host sessions by changing the role to mentor. + +* Provide Session Manager privileges to a registered user. + +**To upload users to the application, do as follows:** + +1. Do one of the following actions: + * Select **Workspace** from the **Application** menu. + * Go to the **Application** menu ![burger menu](media/burgermenu-icon.png) and select **Workspace**. + +2. On the Workspace page, click **Manage user**. + +3. On the **Bulk Upload** tab, click **Download sample CSV** to download the sample CSV file. The downloaded sample file contains information that you must clear before adding the user details. + + ![](media/orgadmin-bulkupload.png) + +4. Enter the user's information such as: + + * Name + * Email ID + * Assigned role + + +

        To assign Session Manager permissions to a user, enter the role in one of the following formats:

        +
          +
        • mentee,session_manager
          • +
        • mentor,session_manager
          • +
        +         + +5. On the **Bulk Upload** tab, click **Upload CSV** and upload the file containing the list of users. + + +

        You will receive an email notification containing a CSV file with the following information about the listed users:

        +
          +
        • Assigned user ID
          • +
        • Whether the user uploaded to the application already exists
          • +
        +         \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/change-language.mdx b/src/docusaurus/versioned_docs/version-3.1/change-language.mdx new file mode 100644 index 0000000..ab1ca42 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/change-language.mdx @@ -0,0 +1,18 @@ +import BurgerMenu from './media/burgermenu-icon.png' +import PortalLanguageSetting from './media/portal-languagesettings.png' +import Admonition from '@theme/Admonition'; + +# Changing the Language Settings + +You can use the application in a language of your choice. + +**To change the language settings, do as follows:** + +
          +
        1. Go to the Application menu
          and select Language.
          2. +
        2. On the Language page, click a Language button of your choice.
          3. +

          + +

          +
        3. Click Submit. The text on the application user interface now appears in the language that you have chosen.
          4. +
        \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/changepassword.mdx b/src/docusaurus/versioned_docs/version-3.1/changepassword.mdx new file mode 100644 index 0000000..901b2a3 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/changepassword.mdx @@ -0,0 +1,30 @@ +import Admonition from '@theme/Admonition'; +import BurgerMenu from './media/burgermenu-icon.png' + +# Changing the Account Password + +For a secure account, you can change your existing password if: + +* You notice a login from an unfamiliar device on the Login activity page. +* You suspect that your account password is compromised. + +

        + +

        After changing the password, you are automatically logged out from all devices.

        + +

        + +**To change the account password, do as follows:** + +1. Do one of the following actions: + + * Select Change password from the Application menu. + * Go to the Application menu and select Change password. + +2. Enter your old password and the new password. + + ![](media/changepassword.png) + +3. Click **Change password**. You will be logged out of your account. + +4. To access your account, log in using your new credentials. \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/createsession-sessionmanager.mdx b/src/docusaurus/versioned_docs/version-3.1/createsession-sessionmanager.mdx new file mode 100644 index 0000000..c9fe6f1 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/createsession-sessionmanager.mdx @@ -0,0 +1,279 @@ +import PartialExample from './_mentored.mdx'; +import Admonition from '@theme/Admonition'; +import BulkUploadTable from './_sessionbulkuploadtable.mdx'; +import FormFieldsNote from './_formfieldscustomizability.mdx'; + +# Creating Sessions for an Organization + +You can create and schedule sessions between mentor and mentees. + +Sessions can be created using any one of the following methods: + +* Using the **Create session** button +* Using bulk upload + +## Using the Create Session Button + +**To create a session, do as follows:** + +1. Do one of the following actions: + + * Select Workspace from the Application menu. + * Go to the Application menu ![](media/burgermenu-icon.png) and select Workspace. + +2. On the Workspace page, click Manage session. + +3. Go to the **Create sessions** tab. + +4. Click the Create session button. The Create a new session page appears. + + ![](media/assignsession.png) + +5. Optionally, to add a session image, click Add image and do one of the following actions: + + * To take a picture, select Take Photo. + * To upload an image, select Choose from library. +

        + +

        Select an image that is relevant to the session topic.

        + +

        + +6. Enter the session information in the Session title box and Description box. + + + +7. To select the type of session, do as follows: + + 1. Click the Session type box. + 2. Select the session type from the Session type dropdown and click Ok. + +

        + +

        You cannot change the session type after publishing the session.

        + +

        + +8. To assign the session to a mentor, do as follows: + + 1. Click + Add mentor. The Mentor list window appears. + 2. Find a mentor from the list and click Add. + +

        + +

        To assign the session to a different mentor, do as follows:

        +
          +
        1. In the + Add mentor box, click the mentor's name that was previously selected.
          2. +
        2. Find a new mentor and click Add.
          3. +
        + +

        + + ![](media/mentorlistwindow.png) + +

        + +

        After publishing the session, you cannot assign the session to a different mentor.

        + +

        +

        + +

        From the Mentor or Mentee list window, you can find users by:

        +
          +
        • Searching for the user in the Search box.
          • +
        • Using filters such as the user's organization or designation.
          • +
        • Changing the number of users listed on the page using the Items per page dropdown.
          • +
        + +

        + +9. To invite mentees, do as follows: + + 1. Click + Add mentee. The Mentee list window appears. + 2. Find a mentee from the list and click Add. + + ![](media/menteelistwindow.png) + +

        + +

          +
        • It is optional to invite mentees to a Public session.
          • +
        • To facilitate one-on-one mentoring, you can set up Private sessions consisting of an invited mentee.
          • +
        + +

        +

        + +

        You cannot add mentees after the session enrollment limit is reached. If you add new mentees after this limit is reached, a session seats full message appears.

        + +

        + +10. To schedule a session, do as follows: + + 1. Click the Start date box and End date box. + 2. Select the date and time from the date and time picker. + 3. Click ![](media/selectdateandtime.png). + +

        + +

        The session duration should be at least 30 minutes.

        + +

        + +11. Select an option from the following: + + * Recommended for + * Categories + * Medium + + ![](media/recommendedcategorymedium.png) + +12. Click **+Select Recommended for**. The **Select Recommended for** window appears. + + ![](media/recommendedfor.png) + +13. Select the checkbox for the options that you want to recommend. You can also do a quick search using the search bar. Type one or + more letters in the search bar. The items are displayed based on the search term you typed. + +14. Do one of the following actions: + * Click **Save** to save the selected Recommended options. + * Click **Clear all** to clear the selected options. + * Click **X** to close the window without saving the changes. + +15. After you click **Save**, the selected items appears under the **+Select Recommended for** section. + + ![](media/selectedrecommends.png) + +16. To add a new item, click **+Other**. This opens a popup window. + + ![](media/other.png) + +17. Enter the recommended item that you would like to add and then click **Ok**. + The newly added item appears as **+1more** as shown in the following figure. + + ![](media/otheroptionadded.png) + + +

        + + A maximum of five options will be shown. + If there are more than five options, they will be denoted with “+number of additional options." + For example, if 11 options are selected, the first five will appear under the + Select Recommended for section, + while the remaining six will be shown as "+6more". + +

        + +18. Repeat the same procedure as **+Select Recommended for**, to select the categories and the medium for creating a session. + + ![](media/categoryandmedium.png) + + +19. Click Publish and add link. The session is published on the platform and mentees can now view the session. + +

        + +

        You must set the meeting platform on the Meeting Link tab.

        + +

        + + ![](media/portal-addmeetinglink.png) + +

        + +

        To go back and edit the session details, do as follows:

        +
          +
        1. Go to the Edit session tab.
          2. +
        2. Make the necessary changes and click Save.
          3. +
        + +

        + +20. On the Meeting link tab, select a meeting platform from the Add meeting link menu. + +

        + +

        If you have not selected a meeting platform, BigBlueButton is set as the default platform.

        + +

        + + + + + + + + + + + + + + + + + + + + + + +
        Meeting PlatformMeeting Information
        BigBlueButtonNo action required.
        Google MeetCopy and paste the call link in the Meet link box.
        WhatsAppCopy and paste the call link in the WhatsApp box.
        Zoom

        Do the following actions:

        1. Copy and paste the meeting link in the Zoom link box.
        2. Copy and paste the meeting ID in the Meeting ID box.
        3. Copy and paste the passcode in the Passcode box.
        + +21. Click Submit. The meeting information is added. + +

        + +

        You can find the sessions that are assigned to mentors and track their progress on the Session list section.

        + +

        + +## Using Bulk Upload + +For an organization's mentorship program, you can create and schedule multiple sessions between mentors and mentees. + +**To create sessions through bulk upload, do as follows:** + +1. Do one of the following actions: + + * Select Workspace from the Application menu. + * Go to the Application menu ![](media/burgermenu-icon.png) and select Workspace. + +2. On the Workspace page, click **Manage session**. + +3. Go to the **Bulk upload** tab. + +4. Click **Download sample CSV** to download the sample CSV file. The downloaded sample file contains information that you must clear before adding the session details. + +5. Open the downloaded CSV file and clear the sample details. + +6. Enter *Create* in the **Action** column. + +7. Leave the **ID** column as blank. + +8. Enter the session information as per the following table: + + + +9. On the **Bulk upload** tab, click **Upload CSV** and select the CSV file containing the list of sessions. To view the published sessions and their session IDs, go to the **Create sessions** tab. + +

        + +

        After creating sessions, you will receive a CSV file in your email that displays details such as:

        +
          +
        • ID
          • +
        • Session status (Published or Invalid)
          • +
        • Status message
          • +
        +

        If the details entered in the uploaded CSV need corrections, the session status would be invalid and the session is not published. In such cases, refer to the status message and reupload the respective file with the updated details.

        To make the necessary updates, see the Troubleshooting Invalid Messages section.

        + +

        + + + + + + + + + + diff --git a/src/docusaurus/versioned_docs/version-3.1/creating-and-managing-mentee-profile.mdx b/src/docusaurus/versioned_docs/version-3.1/creating-and-managing-mentee-profile.mdx new file mode 100644 index 0000000..543fbf5 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/creating-and-managing-mentee-profile.mdx @@ -0,0 +1,111 @@ +import Admonition from '@theme/Admonition'; +import FormFieldsNote from './_formfieldscustomizability.mdx'; + +# Creating a Mentee Profile + +To access the application's features such as enrolling for mentoring sessions, you must provide your profile information after: + +* Signing up to the application. + +* Logging in to the application if: + + * Your profile is incomplete. + * Your organization requires additional mandatory information on your profile. + +**To create your profile, do as follows:** + +1. After signing up or logging in, click **Continue** on the **Setup profile** dialog. + +2. Optionally, to add a profile image, do any one of the following actions: + + * Click Add image and select the image. + * To remove an existing image, click Remove image. + +3. Enter the following information: + + * Your experience in years + * Tell us about yourself + * Education qualification + + + +4. To select your location, click the Select your location box and select the location from the menu. + +5. Select an option from the following: + + * Your role + * Your expertise + * Languages + +

        + +

          +
        • To cancel the selection, click the option again.
          • +
        • To add a new option, do as follows:
          • +
            +
          1. Click + Add or + Other and enter the new option.
            2. +
          2. Click Ok.
            3. +
          +
        • To select all the options, turn on the toggle.
          • +
        + +

        + + ![](media/portal-createprofileoptions.png) + +6. Click Submit. You have created your profile. + +## Accessing the Profile Page + +On the profile page, you can do the following actions: + +* Update your profile. +* View the number of sessions attended. +* View your assigned roles. + +To view the Profile page, do one of the following actions: + +* Do one of the following actions: + + * Select Profile from the Application menu. + * Go to the Application menu ![burger menu](media/burgermenu-icon.png) and select Profile. + + ![](media/portal-menteeapplicationmenu.png) + +* Go to the Profile tab. + + ![](media/profile-icon.png) + +### Updating Your Profile + +**To modify your current profile information, do as follows:** + +1. Click Edit profile on the Profile page. + + ![](media/portal-editmenteeprofile.png) + +2. Make the necessary changes to: + + * Your profile information. + + * Your profile image. To update the profile image, do any one of the following actions: + + * Click Add image and select the image. + * To remove an existing image, click Remove image. + +3. Click Submit. Your profile is updated. + +### Viewing Your Assigned roles + +You can view the list of additional roles (such as mentor, session manager, and organization administrator) that are assigned to you by an organization. + +To view the list of assigned roles, do any one of the following actions: + +* Click the **View roles** link on the Profile page. + +* Do one of the following actions: + + * Click the **View roles** link on the Application menu + * Go to the Application menu ![burger menu](media/burgermenu-icon.png) and click **View roles** link. + +![](media/viewroles-mentee.png) \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/creating-and-managing-mentor-profile.mdx b/src/docusaurus/versioned_docs/version-3.1/creating-and-managing-mentor-profile.mdx new file mode 100644 index 0000000..ac5331f --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/creating-and-managing-mentor-profile.mdx @@ -0,0 +1,120 @@ +import Admonition from '@theme/Admonition'; +import FormFieldsNote from './_formfieldscustomizability.mdx'; + +# Creating a Mentor Profile + +To access the application's features such as hosting mentoring sessions, you must provide your profile information after: + +* Signing up to the application. + +* Logging in to the application if: + + * Your profile is incomplete. + * Your organization requires additional mandatory information on your profile. + + +Your profile details can also help mentees get to know you better. Therefore, ensure that the details are accurate and up-to-date. + + +**To create your profile, do as follows:** + +1. After signing up or logging in, click **Continue** on the **Setup profile** dialog. + +2. Optionally, to add a profile image, do any one of the following actions: + + * Click Add image and select the image. + * To remove an existing image, click Remove image. + +3. Enter the following information: + + * Your experience in years + * Tell us about yourself + * Education qualification + + + +4. To select your location, click the Select your location box and select the location from the menu. + +5. Select an option from the following: + + * Your role + * Your expertise + * Languages + +

        + +

          +
        • To cancel the selection, click the option again.
          • +
        • To add a new option, do as follows:
          • +
            +
          1. Click + Add or + Other and enter the new option.
            2. +
          2. Click Ok.
            3. +
          +
        • To select all the options, turn on the toggle.
          • +
        + +

        + + ![](media/portal-createprofileoptions.png) + +6. Click Submit. You have created your profile. + +## Accessing Your Profile + +On the Profile page, you can do the following actions: + +* Update your profile. +* View the number of sessions conducted. +* View your session ratings. +* View your assigned roles. + +To view the Profile page, do one of the following actions: + +* Do one of the following actions: + + * Select Profile from the Application menu. + * Go to the Application menu ![burger menu](media/burgermenu-icon.png) and select Profile. + + ![](media/portal-menteeapplicationmenu.png) + +* Go to the Profile tab. + + ![](media/profile-icon.png) + +### Updating Your Profile + +**To modify your current profile information, do as follows:** + +1. Click Edit profile on the Profile page. + + ![](media/portal-editmentorprofile.png) + +2. Make the necessary changes to: + + * Your profile information. + + * Your profile image. To update the profile image, do any one of the following actions: + + * Click Add image and select the image. + * To remove an existing image, click Remove image. + +3. Click Submit. Your profile is updated. + +### Viewing Your Assigned roles + +You can view the list of additional roles (such as session manager or organization administrator) that are assigned to you by an organization. + + +

        Every user who registers on the platform is a mentee by default.

        +         + +To view the list of assigned roles, do any one of the following actions: + +* Click the **View roles** link on the Profile page. + +* Do one of the following actions: + + * Click the **View roles** link on the Application menu + * Go to the Application menu ![burger menu](media/burgermenu-icon.png) and click **View roles** link. + +![](media/viewroles-mentor.png) \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/dashboard-for-mentees.mdx b/src/docusaurus/versioned_docs/version-3.1/dashboard-for-mentees.mdx new file mode 100644 index 0000000..393614f --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/dashboard-for-mentees.mdx @@ -0,0 +1,109 @@ +import DashboardIcon from './media/dashboard-icon.png'; +import BurgerMenu from './media/burgermenu-icon.png' +import PortalApplicationMenu from './media/portal-menteeapplicationmenu.png' +import PortalMenteeDashboard from './media/portal-menteedashboard.png' +import Admonition from '@theme/Admonition'; + +# Dashboard for Mentees + +The Dashboard provides a summary of the number of sessions attended by the mentee. + +**To view the Dashboard, do as follows:** + +
          +
        1. To view the Dashboard page, do any one of the following actions:
          2. +
            +
          • Do one of the following actions:
            • +
              +
            • Select Dashboard from the Application menu.
              • +
            • Go to the Application menu and then select Dashboard.
              • +
            +

            + +

            +
          • Go to the Dashboard tab.
            • +

            + +

            +
          +
        + +The mentee dashboard helps to track the total number of sessions attended by the mentees and also the total time spent for learning activities. + +The dashboard provides a summary of the following: + +* Total number of private sessions attended by the mentees. +* Total number of public sessions attended by the mentees. +* Total hours spent on learning sessions. + +The bar chart shows the total number of mentees enrolled for the session and total number of sessions attended by the mentees. + +![](media/menteedashboard.png) + +Use the following options to filter the data suiting to your needs. + + + + + + + + + + + + + + + + + + +
        Filter OptionsDescription
        Duration
        • This week: To view the mentoring sessions attended in the current week.
          • +
        • This month: To view the mentoring sessions attended by the mentees in the current month.
          • +
        • This quarter: To view the mentoring sessions attended in the current quarter.
          • +
        Type
        • All: Shows all the public and private sessions attended by the mentees for the selected duration.
          • +
        • Public: Shows only public sessions.
          • +
        • Private: Shows only private sessions.
          • +
        Categories
        • Select the appropriate category from the dropdown.
        + + + +## Session Details + +You can view the session details, such as **Sessions Title**, **Sessions Created By**, **Mentor Name**, **Date of Session**, **Session Type**, +**Categories**, **Recommended for**, **Session Attended**, and **Duration of Sessions Attended**. + + +From the **Session Details** section you can perform the following actions: + +1. **Sort**: Sort the table data in ascending or descending order using the ![](media/sorticon.png)icon. + +2. **Search**: To perform a quick search, type one or more letters in the search boxes provided. The search results appear based on the search term you typed. + +3. **Select dropdown list**: Choose an appropriate value from the dropdown list to display the result that you require. +For example, to display only the public mentoring sessions, select **PUBLIC** from the **Session Type** dropdown list. + +![](media/menteesessiondetails.png) + +4. **Filter**: **Clear Filters** option appears only after you enter a search criteria in the search boxes provided. + To clear the filter applied, click **Clear Filters**. + +5. **Download Table**: Click **Download Table** to download the table data as a CSV file. + + +

        Only the data for the current month is displayed in the Session Details table.

        +         + + +## Download Table + +**To download the table data, do as follows**: + +1. Click **Download Table**. A pop-up window appears that allows you to select the time period. + +![](media/selectdaterange.png) + +2. Select the start date and the end date using the calendar icon. + +3. Click **Submit** to download the session details as a CSV file for the selected time period. diff --git a/src/docusaurus/versioned_docs/version-3.1/dashboard-for-mentors.mdx b/src/docusaurus/versioned_docs/version-3.1/dashboard-for-mentors.mdx new file mode 100644 index 0000000..936d2dc --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/dashboard-for-mentors.mdx @@ -0,0 +1,124 @@ +import DashboardIcon from './media/dashboard-icon.png'; +import BurgerMenu from './media/burgermenu-icon.png' +import PortalApplicationMenu from './media/portal-mentorapplicationmenu.png' +import PortalMentorDashboard from './media/portal-mentordashboard.png' +import Admonition from '@theme/Admonition'; + +# Dashboard for Mentors + +The Dashboard provides a summary of the number of sessions conducted and attended by the mentor. + +**To view the Dashboard, do as follows:** + +
          +
        1. To view the Dashboard page, do any one of the following actions:
          2. +
            +
          • Do one of the following actions:
            • +
              +
            • Select Dashboard from the Application menu.
              • +
            • Go to the Application menu and select Dashboard.
              • +
            +

            + +

            +
          • Go to the Dashboard tab.
            • +

            + +

            +
          +
        + + +By default, the dashboard displays the mentoring session details for a mentee. You need to change the role to mentor. To change to mentor, select the Mentor role from the **Role** dropdown. + +![](media/changeroletomentor.png) + + +The dashboard provides a summary of the following: + +* Total number of public and private sessions created and conducted by the mentor. +* Total hours of public sessions and private sessions conducted. +* The bar graph gives a quick comparison of the number of sessions created or assigned and the number of sessions conducted. + +![](media/mentordashboard.png) + +Use the following options to filter the data suiting to your needs. + + + + + + + + + + + + + + + + + + +
        Filter OptionsDescription
        Duration
        • This week: To view the number of public or private sessions conducted in the current week.
          • +
        • This month: To view the number of public or private sessions conducted in the current month.
          • +
        • This quarter: To view the number of public or private sessions conducted in the current quarter.
          • +
        Type
        • All: Shows all the public and private sessions hosted for the selected duration.
          • +
        • Public: Shows only public sessions.
          • +
        • Private: Shows only private sessions.
          • +
        Categories
        • Select the appropriate category from the dropdown.
        + + + +## Mentoring Session Details + +You can view the mentoring session details, such as **Sessions Title**, **Sessions Created By**, **Number of Mentees**, +**Date of Session**, **Session Type**, **Session Conducted**, and **Duration of Sessions Attended**. + + + +From this section you can perform the following actions: + +1. **Sort**: Sort the table data in ascending or descending order using the![](media/sorticon.png)icon. + +2. **Search**: To perform a quick search, type one or more letters in the search boxes provided. The search results appear based on the search term you typed. + +3. **Select dropdown list**: Choose an appropriate value from the dropdown list to display the result that you require. +For example, to display only the public mentoring sessions, select **PUBLIC** from the **Session Type** dropdown list. + + + +![](media/mentorsessiondetails.png) + +4. **Filter**: **Clear Filters** option appears only after you enter a search criteria in the search boxes provided. + To clear the filter applied, click **Clear Filters**. + +5. **Download Table**: Click **Download Table** to download the table data as a CSV file for the selected duration. + + +

        Only the data for the current month is displayed in the Mentoring Session Details table.

        +         + +## Download Table + +**To download the table data, do as follows**: + +1. Click **Download Table**. A pop-up window appears that allows you to select the time period. + +![](media/selectdaterange.png) + +2. Select the start date and the end date using the calendar icon. + +3. Click **Submit** to download the data as a CSV file for the selected time period. + + + + + + + + + + + diff --git a/src/docusaurus/versioned_docs/version-3.1/dashboard-for-sm.mdx b/src/docusaurus/versioned_docs/version-3.1/dashboard-for-sm.mdx new file mode 100644 index 0000000..4a2b365 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/dashboard-for-sm.mdx @@ -0,0 +1,117 @@ +import DashboardIcon from './media/dashboard-icon.png'; +import BurgerMenu from './media/burgermenu-icon.png' +import PortalApplicationMenu from './media/portal-menteeapplicationmenu.png' +import PortalMenteeDashboard from './media/portal-menteedashboard.png' +import SessionManagerMenu from './media/sessionmanagerpage.png' +import Admonition from '@theme/Admonition'; + +# Dashboard for Session Managers + +The Dashboard gives you a summary of the total number of sessions hosted, total hours taken for the mentoring activity, +and the mentor rating received for the sessions conducted. + + +**To view the Dashboard, do as follows:** + +
          +
        1. To view the Dashboard page, do any one of the following actions:
          2. +
            +
          • Do one of the following actions:
            • +
              +
            • Select Dashboard from the Application menu.
              • +
            • Go to the Application menu and select Dashboard.
              • +
            +

            + +

            +
          • Go to the Dashboard tab.
            • +

            + +

            +
          +
        + + +By default, the dashboard displays the mentoring session details for a mentee. You need to change the role to session manager. +To change to session manager, select the **Session Manager** role from the **Role** dropdown. + + ![](media/changeroletosm.png) + +The dashboard provides a summary of the following: + +* Total number of public and private sessions created. +* Total number of public and private sessions successfully conducted. +* Total hours spent by session managers on session creation. + + ![](media/smdashboard.png) + + +

        Hover over the bar graph to see the number of public and private sessions created/conducted.

        +         + +Use the following options to filter the data suiting to your needs. + + + + + + + + + + + + + + + + + + +
        Filter OptionsDescription
        Duration
        • This week: To view the sessions created and conducted in the current week.
          • +
        • This month: To view the sessions created and conducted in the current month.
          • +
        • This quarter: To view the sessions created and conducted in the current quarter.
          • +
        Type
        • All: Shows all the public and private mentoring sessions hosted for the selected duration.
          • +
        • Public: Shows only public sessions.
          • +
        • Private: Shows only private sessions.
          • +
        Categories
        • Select the appropriate category from the dropdown.
        + +## Session Details + +You can view the session details, such as **Mentor Name**, **Number of Mentoring Sessions**, **Hours of Mentoring Sessions**, +and **Avg Mentor Rating**. + + +From this section you can perform the following actions: + +1. **Sort**: Sort the table data in ascending or descending order using the ![](media/sorticon.png)icon. + +2. **Search**: To perform a quick search, type one or more letters in the search boxes provided. The search results appear based on the search term you typed. + +3. **Select dropdown list**: Choose an appropriate value from the dropdown list to display the result that you require. For example, select a relevant value from + the **Number of Mentoring Sessions** dropdown to list the number of sessions conducted by a mentor. + + + ![](media/smsessiondetails.png) + +4. **Filter**: **Clear Filters** option appears only after you enter a search criteria in the search boxes provided. + To clear the filter applied, click **Clear Filters**. + +5. **Download Table**: Click **Download Table** to download the table data as a CSV file. + + +

        Only the data for the current month is displayed in the Session details table.

        +         + + +## Download Table + +**To download the session details, do as follows**: + +1. Click **Download Table**. A pop-up window appears that allows you to select the time period. + +![](media/selectdaterange.png) + +2. Select the start date and the end date using the calendar icon. + +3. Click **Submit** to download the table data as a CSV file for the selected time period. \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/databasedesign.mdx b/src/docusaurus/versioned_docs/version-3.1/databasedesign.mdx new file mode 100644 index 0000000..0ee8746 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/databasedesign.mdx @@ -0,0 +1,5 @@ +import MentorSchema from './media/db-mentor.png'; + +# Database Design for Mentor Service + +
        diff --git a/src/docusaurus/versioned_docs/version-3.1/discussions.mdx b/src/docusaurus/versioned_docs/version-3.1/discussions.mdx new file mode 100644 index 0000000..20e2768 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/discussions.mdx @@ -0,0 +1,15 @@ +import PartialExample from './_mentored.mdx'; + +# Discussions + +Join our discussion forums to seek assistance on microservices and the Progressive Web App (PWA) from our development team, to contribute to the community by suggesting enhancements, and to stay updated with the latest enhancements. + +|Component|Discussion Forum| +|--------------|-----------| +| Service| https://github.com/ELEVATE-Project/mentoring/discussions| +| PWA|https://github.com/ELEVATE-Project/mentoring-mobile-app/discussions| +|User Service|https://github.com/ELEVATE-Project/user/discussions| +|Interface Service|https://github.com/ELEVATE-Project/interface-service/discussions| +|Scheduler Service|https://github.com/ELEVATE-Project/scheduler/discussions| +|Notification Service|https://github.com/ELEVATE-Project/notification/discussions| +|Utils Service|https://github.com/ELEVATE-Project/utils/discussions| \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/enrolling-for-a-session.mdx b/src/docusaurus/versioned_docs/version-3.1/enrolling-for-a-session.mdx new file mode 100644 index 0000000..9d441f1 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/enrolling-for-a-session.mdx @@ -0,0 +1,82 @@ +import PartialExample from './_mentored.mdx'; +import Admonition from '@theme/Admonition'; +import SearchSession from './_searchsession.mdx'; + +# Enrolling for a Session + +You can explore Public sessions on and sign up for sessions in your chosen domain or by a mentor of your choice. + + +
          +
        • If a session manager invites you to a Public or Private session, you are automatically enrolled to the session.
          • +
        • You cannot enroll for a session after the enrollment limit is reached. If you try to enroll after this limit is reached, a Session seats full message appears.
          • +
        • You can enroll for an ongoing session, which appears as Live on the Home page.
          • +
        +         + +You can enroll for Public sessions in one of the following ways: + +* Using the **All sessions** tab +* Using the mentor profile +* Using the Session details page +* Using the **Search** box + +## Using the All Sessions Tab + +1. On the Home page, go to the **All sessions** tab. + +2. Find a session of interest and click **Enroll**. The enrolled sessions are listed on the **Enrolled sessions** tab of the Home page. + + ![](media/portal-enrollbutton.png) + +## Using the Mentor Profile + + +

        See Mentor Directory to learn more about accessing the mentor profile.

        +         + +**To enroll for a session using the mentor profile, do as follows:** + +1. On the Mentor Profile page, go to the **Upcoming sessions** tab. + +2. Click **Enroll**. The enrolled sessions are listed on the **Enrolled sessions** tab of the Home page. + + ![](media/portal-mentorprofileenroll.png) + +## Using the Session Details Page + +1. Find a session from the **All sessions** tab or the Mentor Profile page. + +2. Click the session tile to view the Session Details page. + + ![](media/portal-sessiontileenroll.png) + +3. Click **Enroll**. The enrolled sessions are listed on the **Enrolled sessions** tab of the Home page. + + ![](media/portal-sessiondetailsenroll.png) + +## Using the Search Box + +1. +2. Click **Enroll**. The enrolled sessions are listed on the Enrolled sessions tab of the Home page. + +## Cancelling Your Enrollment + + +
          +
        • If you were invited to a session, you cannot cancel your enrollment for the session.
          • +
        • You can cancel your enrollment if the mentor has not started the session.
          • +
        +         + +**To cancel your enrollment, do as follows:** + +1. On your Home page, go to the **Enrolled sessions** tab. + +2. Click the session tile. + +3. Click **Unenroll**. + + ![](media/portal-cancelenrollment.png) + +4. Click **Unenroll** on the confirmation dialog. The session is removed from the **Enrolled sessions** tab of the Home page. \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/faq.mdx b/src/docusaurus/versioned_docs/version-3.1/faq.mdx new file mode 100644 index 0000000..b921986 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/faq.mdx @@ -0,0 +1,353 @@ +import PartialExample from './_mentored.mdx'; +import Admonition from '@theme/Admonition'; +import ResetPassword from './_resetpassword.mdx'; + +# FAQ on Mentor + +
        +What does application offer? +

        is an open source solution that creates a mentoring network and make experts discoverable to mentees to connect and seek guidance for professional development.

        + +

        To learn more, see Welcome to .

        + +
        + +
        +How can mentors and mentees use ? + +* Mentors can create sessions and join other sessions. +* Mentees can join sessions. + +To learn more, see About the Application. +
        + +
        +How can organizations manage users (mentors and mentees) on the platform? + +Users with Organization Administrator privileges can manage users in the following ways: + +* Upload the list of users with preassigned roles to the platform. +* Manage users' requests to become a mentor. + +To learn more, see the following topics: + +* Uploading Users to the Application +* Managing Requests to Become a Mentor + +
        + +
        +How can organizations manage sessions on the platform? + +Session managers can create Public or Private sessions and do the following actions: + +* Assign the sessions to respective mentors. The assigned sessions are hosted by mentors during the scheduled time. +* Invite mentees to the sessions. +* Conduct session management activities such as updating the session and meeting details and tracking the session's status and mentee enrollments. + +To learn more, see the following topics: + +* Creating Sessions for an Organization +* Managing Sessions Assigned to Mentors + +
        + +
        +How can I sign up on ? + +After receiving an email invite containing the application's link, new users can sign up to create their accounts. If you have received a session or mentor profile link from your contacts, you can use the link to sign up as a mentee. +

        + +

        By default, everyone on has mentee privileges to connect with mentors and seek guidance (through mentoring sessions).

        + +

        + +To learn more, see the following topics: + + +
        + +
        +What if I don't remember my password? +If you don't remember your password, you can reset it as follows: + +
        + +
        +What to do if I face issues while signing up or logging in? + +If you face any issues while logging in or signing up, you can write to the support team describing the issue. + +To learn more, see Reporting Issues Related to Signing up and Logging in. +
        + +
        +How to change the language on the application? + +You can select the language of your choice using the **Language** option from the **Application** menu. + +To learn more, see Changing the Language Settings. +
        + +
        +What to do if I face any technical issues? + +If you face any technical issues, you can report the issue to the support team on the Help page. + +To learn more, see Reporting an Issue. +
        + +
        +How can I keep my account secure? + +You can keep your account secure by: + +* Viewing the Login activity page and logging out from devices that are unfamiliar or not in use. +* Change your existing password if you: + + * Suspect that your account password is compromised. + * Notice a login from an unfamiliar device on the Login activity page. + +To learn more, see the following topics: + + +
        + +
        +Where can I find the video instructions about using the application features? + +To view the video instructions, you can go to the **Application** menu and select the **Help videos** option. + +To learn more, see Viewing the Help Videos. +
        + +
        +Can I edit my profile details later? + +After signing up, you can update your profile details any time. + +To learn more, see the following topics: +* Creating a Mentor Profile +* Creating a Mentee Profile + +
        + +
        +Can I become a mentor? + +If you are a mentee, you can click **Become a Mentor** to send a request to the organization administrator. The request approval process ensures that the organization can validate the credentials of individuals before they are added as mentors. + +To learn more, see Requesting to Become a Mentor. + +
        + +
        +Can I view my assigned roles? + +Click the **View roles** link to view your default role (mentee) or any additional roles that have been assigned to you. + +To learn more, see the following topics: +* Creating a Mentor Profile +* Creating a Mentee Profile + +
        + +
        +Where can I find details about mentors? + +You can use the Mentor Directory to look up details on individual mentors. +
        + +
        +How can I create a session? +To create a new session, go to the My mentoring sessions tab on the Home page and click Create session. + +To learn more, see Setting up a Session. +
        + +
        +Can I make changes to the session details or timings? + +You can edit a session to change the timings or the details associated with it. In case you want to cancel the session, you can delete the session. + +To learn more, see Setting up a Session. +
        + +
        +What is the duration of each session? + +The minimum duration of a session should be 30 minutes. + +To learn more, see Setting up a Session. +
        + +
        +How many sessions can I create? + +The platform does not apply any limits on the number of sessions that a mentor can host. + +To learn more, see Setting up a Session. +
        + +
        +What are the meeting platforms available to host my session? + +Mentors can host their sessions using any one of the following meeting platforms: + +* BigBlueButton +* Google Meet +* WhatsApp +* Zoom + +To learn more, see Setting up a Session. +
        + +
        +How do I start my session? + +On the My Mentoring Sessions tab, click Start to host sessions that you have created or the ones that have been assigned to you by a session manager. + +To learn more, see Starting a Session. +
        + +
        +Are these sessions pre-recorded or live? + +Mentoring sessions are live sessions hosted by mentors. You cannot upload or host a recorded session. + +To learn more, see the following sections: +* Joining a Session +* Starting a Session + +
        + +
        +Where can I find the upcoming sessions? + +You can find the upcoming sessions on the All sessions tab of the Home page. + +To learn more, see Enrolling for a Session. +
        + +
        +How can I register for a session? + +On the All sessions tab of the Home page, you can find a session of interest and click Enroll. + +To learn more, see Enrolling for a Session. +
        + +
        +Where can I find my enrolled sessions or sessions to which I am invited? + +On the Enrolled sessions tab on the Home page, you can view the list of sessions to which you have enrolled or you have been invited. + +To learn more, see Joining a Session. +
        + +
        +Is there a limit on the number of participants who can enroll for a session? + +You cannot enroll for a session after the enrollment limit is reached. If you try to enroll after this limit is reached, a *Session seats full* message appears. + +To learn more, see Enrolling for a Session. + +
        + +
        +Can I cancel my enrollment? + +You can cancel your enrollment if the mentor has not started the session. + +To learn more, see Cancelling Your Enrollment. +
        + +
        +How do I attend a session? + +On the Enrolled sessions tab of the Home page, you can find the enrolled or invited session and click Join. + +To learn more, see Joining a Session. +
        + +
        +Can I share session links? + +The host and participants can share session links with their phone or email contacts, and over social media. + +To learn more, see the following topics: + +* How can a session host share the session invite? +* How can a participant share the session invite? + +
        + +
        +Can participants who have not registered on attend sessions using a link? + +To join sessions using a link, participants must sign up on . + +To learn more, see Joining a Session. +
        + +
        +How can I track my progress? +You can track your activity and track your progress using one of the following ways: + +* Go to the **Dashboard** tab. +* Select the **Dashboard** option from the **Application** menu. + +To learn more, see the following topics: + +* Dashboard for Mentors +* Dashboard for Mentees + +
        + +
        +Can I provide a feedback for the session? + +At the end of each session, the host and participants can rate the session. + +To learn more, see the following topics: + +* How mentors can record their feedback? +* How mentees can record their feedback? + +
        + +
        +Can I view the ratings for the sessions I have hosted? + +You can view your session rating using one of the following ways: + +* Go to the **Profile** tab. +* Select the **Profile** option from the **Application** menu. + +To learn more, see Creating a Mentor Profile. +
        + +
        +Can I view a mentor’s session ratings? + +You can view a mentor’s session ratings using the Mentor Directory. +
        + +
        +How can I delete my account? + +You can create a request to delete your account on the Help page. + +To learn more, see any one of the following topics: +* How mentors can create a request for deleting their account? +* How mentees can create a request for deleting their account? + +
        diff --git a/src/docusaurus/versioned_docs/version-3.1/feedbackformentees.mdx b/src/docusaurus/versioned_docs/version-3.1/feedbackformentees.mdx new file mode 100644 index 0000000..cf970a0 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/feedbackformentees.mdx @@ -0,0 +1,21 @@ +import PartialExample from './_mentored.mdx'; + +# Providing Session Feedback as a Mentee + +At the end of the session, mentees can share feedback by providing a rating for the following: + +* Mentor +* Session interaction +* Quality of online interaction +* Session content +* Relevance of the session to your role + +**To provide a feedback, do as follows:** + +1. After the session, go to . + +2. Enter the ratings and tap Submit Feedback. The feedback is recorded. + + ![](media/portal-participantfeedback.png) + + diff --git a/src/docusaurus/versioned_docs/version-3.1/feedbackformentors.mdx b/src/docusaurus/versioned_docs/version-3.1/feedbackformentors.mdx new file mode 100644 index 0000000..e488340 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/feedbackformentors.mdx @@ -0,0 +1,17 @@ +import PartialExample from './_mentored.mdx'; + +# Providing Session Feedback as a Mentor + +At the end of the session, the mentor can share feedback by providing a rating for the following: + +* Session interaction +* Quality of online interaction + +**To provide a feedback, do as follows:** + +1. After the session, go to . + +2. Enter the ratings and tap Submit Feedback. The feedback is recorded. + + ![](media/portal-hostfeedback.png) + diff --git a/src/docusaurus/versioned_docs/version-3.1/gettingstarted.mdx b/src/docusaurus/versioned_docs/version-3.1/gettingstarted.mdx new file mode 100644 index 0000000..bd28191 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/gettingstarted.mdx @@ -0,0 +1,38 @@ +import PartialExample from './_mentored.mdx'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import ReactPlayer from 'react-player'; +import portalOverview from './media/portaloverview.mp4'; +import mobileOverview from './media/mobileoverview.mp4'; +import Admonition from '@theme/Admonition'; + +# Getting Started with Mentor + +After receiving the application's link, you can get started using one of the following ways: + +* Click the link to view the portal on the web browser. + +

        + +

          +
        • If the web portal does not load, update your web browser and retry.
          • +
        • The supported web browsers are Google Chrome, Firefox, and Safari.
          • +
        + +

        + +* On the web browser, select the Install option to install the application on your device. + + + + + + + + + + +

        To learn more about signing up and accessing the capabilities, refer to the following sections:

        + +* Signing up as a Mentor +* Signing up as a Mentee \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/intro.mdx b/src/docusaurus/versioned_docs/version-3.1/intro.mdx new file mode 100644 index 0000000..2b87294 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/intro.mdx @@ -0,0 +1,58 @@ +import PartialExample from './_mentored.mdx'; +import Shiksha from './_shiksha.mdx'; +import Admonition from '@theme/Admonition'; +import Intro from './media/intro.png'; + +# Welcome to Mentor + + is a composite building block through which mentees and mentors can engage in online interactions to facilitate professional development through peer learning and community building. + +> + + +

        To experience the capability, you can explore the reference application in the sandbox environment.

        +         + +## Overview + +This microsite contains detailed documentation that helps organizations understand the ** building block**. + +## Introduction + +With the ubiquity of the Internet, learners have access to online learning and training resources from across the globe. The COVID-19 pandemic gave an impetus, and today, India has over 13.6 million learners online (WEF report 2022) — the second largest in the world. Yet, people need to be more skilled to get employed. + +This gap needs to be bridged through a network of mentors and experts available in our ecosystem. Expertise is available in each domain, but we need to build pathways to connect mentees with mentors to seek guidance. + + +

        The government has undertaken many initiatives to drive learners online, like the National Digital Educational Architecture (NDEAR), PM eVIDYA Program, Samagra Shiksha Scheme, ‘ShaGun’, DIKSHA, SWAYAM, Shiksha Van, E-Pathshala, National Repository of Open Educational Resources (NROER), and to upskill them with emerging technologies such as National Digital Literacy Mission (NDLM) and FutureSkills (NASSCOM).

        +

        The National Education Policy (2020) has identified the need to create a marketplace where mentors and mentees discover one another and engage for guidance and professional development. The National Mentoring Mission (NMM) envisions a large, decentralized, tech-assisted mentoring structure at different levels of the education and upskilling ecosystem. The NMM encourages the use of digital technologies to make the initiative auto-scalable, diverse, inclusive, and context-aware.

        +

        Many upskilling programs have been rolled out to develop digital skills. Digital skills are critical for teachers to leverage learning platforms like DIKSHA and SWAYAM and access OERs. Digital mentoring programs can leverage the expertise available in the community to upskill teachers to acquire digital skills.

        +

        capability’s great strength is the diversity of programs and domains where mentors and mentees work together.

        +

        Upskilling ASHA project: ASHA (Accredited Social Health Activist) workers are the frontline health caretakers in the public healthcare system. Capacity building of ASHA is a continuous process and requires knowledge of handling practical situations. ASHAs are associated with Auxiliary Nurse Midwives (ANMs) who mentor and guide them. Mentor capability ensures that ASHA workers always have access to their mentor (ANM) for continued guidance and support.

        +         + +Mentoring fosters a sense of belonging, motivation, and confidence among learners, as they receive encouragement, feedback, and recognition from their mentors. + +## Mentor Building Block + + building block facilitates the development of a mentoring network by enabling online interactions between mentees and mentors in the ecosystem. Using the network, mentees can search for and discover experts and seek guidance for professional development.
        + +> + +The capability endeavours to build a marketplace for mentors and mentees where mentees discover (trusted) mentors, establish a connection, and join mentoring sessions. Thereafter, the mentor and mentee rate the session and share their feedback. + +Currently, only mentor-driven interactions (group and one-on-one mentoring) can be carried out using the building block. + +The long-term vision of the building block is to create a country-wide pool of academic experts in different subjects and areas of knowledge to support the workforce. The building block has the potential to address the **skill gap** in all sectors of the economy. It encourages a cross-section of ideas and information sharing and opens avenues for cross-learning and interdisciplinary growth. + +It can be leveraged to upskill and build capability in academia, government organizations, and corporations. Over time, such a rich and reliable pool of mentors can become a vital resource for new entrants in the job market and the existing workforce to stay abreast of future skills. Thus, continuously upskilling the society's **human capital base** and keeping them job-fit. + + includes a microservice, reference portal or web application, and data analytics. The service is developed in compliance with NDEAR principles. The services are generic, configurable, scalable, and interoperable. + +> + +If is being hosted as a standalone capability and not as part of an existing platform, you can leverage the following services: + +* User Management +* Scheduler +* Notification \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/inviting-mentorsandmentees-host.mdx b/src/docusaurus/versioned_docs/version-3.1/inviting-mentorsandmentees-host.mdx new file mode 100644 index 0000000..df24341 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/inviting-mentorsandmentees-host.mdx @@ -0,0 +1,20 @@ +import ShareIcon from './media/share-icon.png'; +import PortalShareSessionHost from './media/portal-editsession.png' +import PartialExample from './_mentored.mdx'; +import Admonition from '@theme/Admonition'; + +# Promoting Your Public Sessions + +If you are hosting a Public session, you can increase participation in your session by sharing a session link. + +**To share a session link, do as follows:** + +
          +
        1. On the Home page, go to the My mentoring sessions tab.
          2. +
        2. Find a session and click the session tile.
          3. +
        3. Click Share to copy the session link.
          4. +

          + +

          +
        4. Share the session link with your contacts or on social media.
          5. +
        \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/inviting-mentorsandmentees-participants.mdx b/src/docusaurus/versioned_docs/version-3.1/inviting-mentorsandmentees-participants.mdx new file mode 100644 index 0000000..9a80b8f --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/inviting-mentorsandmentees-participants.mdx @@ -0,0 +1,34 @@ +import ShareIcon from './media/share-icon.png'; +import PortalShareSessionParticipant from './media/portal-sessiondetailsenroll.png' +import PartialExample from './_mentored.mdx'; +import Admonition from '@theme/Admonition'; + +# Promoting Public Sessions with Your Contacts + +If you think a Public session may be of interest to people in your social circles, you can share the session link with them. + +

        You can share a session link in one of the following ways:

        +
          +
        • Using the All sessions tab
          • +
        • Using the Enrolled sessions tab
          • +
        +

        Using the All Sessions Tab

        +
          +
        1. On the Home page, go to the All sessions tab.
          2. +
        2. Find an upcoming session and click the session tile.
          3. +
        3. Click Share to copy the session link.
          4. +

          + +

          +
        4. Share the session link with your contacts or on social media.
          5. +
        +

        Using the Enrolled Sessions Tab

        +
          +
        1. On the Home page, go to the Enrolled sessions tab.
          2. +
        2. Find an enrolled session and click the session tile.
          3. +
        3. Click Share to copy the session link.
          4. +

          + +

          +
        4. Share the session link with your contacts or on social media.
          5. +
        \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/joinassignedsession.mdx b/src/docusaurus/versioned_docs/version-3.1/joinassignedsession.mdx new file mode 100644 index 0000000..a4c9e89 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/joinassignedsession.mdx @@ -0,0 +1,81 @@ +import Admonition from '@theme/Admonition'; +import PartialExample from './_mentored.mdx'; +import JoinStepPortal from './_joinsessionstep-portal.mdx'; +import ViewSessionList from './media/sessionlist-view.png'; + +# Joining Sessions Assigned to Mentors + +Session managers can join sessions assigned to mentors as a regular mentee. After joining the session, you can monitor the session and make the necessary changes to the session such as changing the meeting information. + +## Enrolling for the Session + +Before joining a Public or Private session, you must enroll for the session. + +

        + +

        Session managers can enroll for sessions that are assigned to a mentor even if the session seats are filled by enrolled and invited mentees.

        + +

        + +**To enroll for a session, do as follows:** + +1. Do one of the following actions: + + * Select Workspace from the Application menu. + + * Go to the Application menu ![burger menu](media/burgermenu-icon.png) and select Workspace. + +2. Click **Manage sessions**. The Session list section appears. + +3. Find the session and click ![](media/sessionlist-view.png). The Session Details page appears. + +4. Click **Enroll**. The session is listed on the Enrolled sessions tab of the Home page. + +

        + +

        After enrolling, the Mentee count remains unchanged on the Session Details page, while your name is listed on the Mentee list window. See the following sections to learn more:

        + + +

        + + ![](media/assignedsessiondetails.png) + +

        + +

        To explore other ways of enrolling for a Public session, see Enrolling for a Session.

        + +

        + +### Cancelling the Enrollment + +**To cancel your enrollment for a Public or Private session, do as follows:** + +1. On the Session list section, find the enrolled session and click ![](media/sessionlist-view.png). + +2. On the Session Details page, click **Unenroll**. + +3. Click **Unenroll** on the confirmation dialog. + +

        + +

        Session managers can also use the Enrolled sessions tab to cancel your enrollment for a Public session. See Cancelling Your Enrollment to learn more.

        + +

        + +## Joining Sessions + +

        To join sessions, do as follows:

        +
          +
        1. On the Session list section, find the enrolled session and click .
          2. +
        2. On the Session Details page, click Join.
          3. + +
        + +

        + +

        To explore other ways of joining sessions, see Joining a Session.

        + +

        diff --git a/src/docusaurus/versioned_docs/version-3.1/joining-a-session.mdx b/src/docusaurus/versioned_docs/version-3.1/joining-a-session.mdx new file mode 100644 index 0000000..23ae3f0 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/joining-a-session.mdx @@ -0,0 +1,181 @@ +import PortalJoinButton from './media/portal-joinbutton.png'; +import PortalSessionTileJoin from './media/portal-sessiontilejoin.png' +import InvitedSessionTileJoin from './media/invitedsessiontile.png' +import PortalSearchSessions from './media/portal-searchsessions.png' +import PortalSessionDetailsJoin from './media/portal-sessiondetailsjoin.png' +import InvitedSessionDetailsJoin from './media/invitedsessiondetailsjoin.png' +import PortalMentorProfileJoin from './media/portal-mentorprofilejoin.png' +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import Admonition from '@theme/Admonition'; +import PartialExample from './_mentored.mdx'; +import JoinStepPortal from './_joinsessionstep-portal.mdx'; +import SearchSession from './_searchsession.mdx'; + +# Joining a Session + +After the mentor starts the sessions, you can join: + +* Public sessions to which you have enrolled or were invited by a session manager. +* Private sessions to which you were invited. + + +You can join the session anytime within the time allocated for the session. + + +You can join a session in one of the following ways: + +* Using the **Enrolled sessions** tab +* Using the **All sessions** tab +* Using the mentor profile +* Using the Session Details page +* Using the **Search** box + + +
          +
        • Private sessions to which you were invited are listed only on the Enrolled sessions tab.
          • +
        • On the Enrolled sessions tab, you can click the session title to join the session using the Session Details page.
          • +
        +         + +## Using the Enrolled Sessions Tab + + +

        To look for sessions to which you were invited, check the session tile that is labelled as invited.

        +         + +**To join sessions using the Enrolled sessions tab, do as follows:** + +1. On the Home page, go to the **Enrolled sessions** tab. + +2. Find the session. + +3. Click **Join**. +

        + +

        If an error occurs, go back to and click Join.

        + +

        + + +

        + +

        +         + +

        + +

        +         +         + +4. + +## Using the All Sessions Tab + + +

        To look for Public sessions to which you were invited, check the session tile that is labelled as invited.

        +         + +**To join sessions using the All sessions tab, do as follows:** + +1. On the Home page, go to the **All Sessions** tab. + +2. Find the session. + +3. Click **Join**. + + +

        + +

        +         + +

        + +

        +         +         + +4. + +## Using the Mentor Profile + + +

        See Mentor Directory to learn more about accessing the mentor profile.

        +         + +**To join a Public session using the mentor profile, do as follows:** + +1. On the Mentor Profile page, go to the **Upcoming sessions** tab. + +2. Click **Join**. + +

        + +

        + +3. + +## Using the Session Details Page + +1. Find the session from the **All Sessions** tab, **Enrolled Sessions** tab, or the Mentor Profile page. + +2. Click the session tile to view the Session Details page. + +

        + +

        + +3. Click **Join**. + + + +

        + +

        +         + +

        + +

        +         +         + +4. + +## Using the Search box + + +

        To look for Public sessions to which you were invited, check the session tile or mentor's name that is labelled as invited.

        +         + +**To find Public sessions to which you have enrolled or were invited, do as follows:** + +1. + +2. Click **Join**. + +3. + +

        + +

        To configure the meeting settings, see any one of the following sections:

        + + +

        + +## Usage Guidelines + +- Unmute your microphone only when necessary. + +- Maintain a neat background and attire before you turn on your webcam. + +- Use respectful language while sharing any information. + +- If you leave a BigBlueButton meeting unintentionally (by pressing the back key on your phone or closing the meeting tab), go back to and click Join. \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/joining-sessions-using-a-shared-link.mdx b/src/docusaurus/versioned_docs/version-3.1/joining-sessions-using-a-shared-link.mdx new file mode 100644 index 0000000..ae71a56 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/joining-sessions-using-a-shared-link.mdx @@ -0,0 +1,46 @@ +import PortalSessionDetailsJoin from './media/portal-sessiondetailsjoin.png' +import Admonition from '@theme/Admonition'; +import PartialExample from './_mentored.mdx'; +import JoinStepPortal from './_joinsessionstep-portal.mdx'; + +# Using a Shared Link to Join a Session + +You can join a Public session on using a link shared by your contacts or on social media. + + +

        Users who have not registered on yet, should do the following actions:

        +
          +
        1. Click the shared link to open .
          2. +
        2. Sign up to create a new account.
          3. +
        3. Update your profile.
          4. +
        +

        If you are a registered user, log in to your account.

        +         + +

        To join a session using a shared link, do as follows:

        +
          +
        1. Click the shared link.
          2. +
        2. On the Session details page, click Join.
          3. +

          + +

          If you haven't enrolled for the session yet, click Enroll.

          + +

          +

          + +

          + +
        + + + + \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/key-capabilities.mdx b/src/docusaurus/versioned_docs/version-3.1/key-capabilities.mdx new file mode 100644 index 0000000..04c70ca --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/key-capabilities.mdx @@ -0,0 +1,82 @@ +import PartialExample from './_mentored.mdx'; + +# Key Capabilities of Mentor + +Using the building block, domain experts or mentors become easily accessible to mentees through online interactions. The capability leverages video conferencing tools for mentees to connect and join mentoring sessions. + +> + + currently supports group and one-on-one mentoring interactions. In group mentoring, a group of mentees get associated to a mentor in a session. The mentor creates sessions and publish them on the platform. The session follows a format similar to a webinar. However, it encourages a long-term relationship between mentors and mentees. + +> + +Through group mentoring, mentees can access upskilling and capacity-building opportunities. It also opens doors for interdisciplinary skill development. + +> + +On the other hand, a one-on-one mentoring session involves assigning a mentee to a mentor. Through one-on-one mentoring, mentees can address their goals and concerns about their professional development and receive personalized guidance from the mentor. + +## Capabilities of Mentor + +One of the most important things to recognize about **mentoring as an approach to learning** is that it is incredibly diverse and can have a formal or informal setup. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        FeatureDescription
        Search for MentorsMentees can look up mentors in their chosen area of expertise.
        Schedule SessionsUsers registered as mentors can create and publish the schedule for mentoring sessions.
        Discover SessionsRegistered users can easily search and discover upcoming mentoring sessions.
        Enroll for a SessionUsers registered as mentees (and mentors) can enroll in Public sessions hosted by mentors.
        Conduct Live SessionsMentors can conduct live group or one-on-one mentoring sessions.
        Join Live SessionEvery user is a mentee (by default) and can join sessions hosted by mentors.
        Record SessionsAll sessions can be recorded and archived on the organizations's cloud storage.
        Session Quality and FeedbackUsers can provide feedback on the quality of interaction and rate the session.
        Manage Users and RolesUsers with Organization Administrator privileges can create and manage users.
        Manage SessionsUsers with Session Manager privileges can assign sessions to mentors and manage the sessions.
        + +In addition to the microservice, the building block provides additional microservices such as: + +* User Service. +* Notification Service. +* Scheduler Service. + +The building block can be deployed as a standalone capability or used in conjunction with other learning and development management solutions. + +An instance of (sandbox solution) is created to demonstrate some of the capabilities. This document provides the user guide for the reference solution (). + + + + diff --git a/src/docusaurus/versioned_docs/version-3.1/logging-in-mentee.mdx b/src/docusaurus/versioned_docs/version-3.1/logging-in-mentee.mdx new file mode 100644 index 0000000..88f3a75 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/logging-in-mentee.mdx @@ -0,0 +1,28 @@ +import PartialExample from './_mentored.mdx'; +import Admonition from '@theme/Admonition'; +import LogIn from './_login.mdx'; +import PortalHomeMentee from './media/portal-menteehomepage.png' +import ResetPassword from './_resetpassword.mdx'; + +# Logging in as a Mentee + +After signing up, you can log in to access the Home page. + +**To log in to the Home page, do as follows:** + +
          + +
        1. Click Login. The Home page appears.
          2. + +

          To access your Home page and other application features, your profile must be complete.

          +           + +
        + +## Resetting a Forgotten Password + +While logging in, if you don't remember your password you can change it. + +To reset your password, do as follows: + + \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/logging-in-mentor.mdx b/src/docusaurus/versioned_docs/version-3.1/logging-in-mentor.mdx new file mode 100644 index 0000000..e878c58 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/logging-in-mentor.mdx @@ -0,0 +1,28 @@ +import PartialExample from './_mentored.mdx'; +import Admonition from '@theme/Admonition'; +import LogIn from './_login.mdx'; +import PortalHomeMentor from './media/portal-mentorhomepage.png' +import ResetPassword from './_resetpassword.mdx'; + +# Logging in as a Mentor + +After signing up, you can log in to access the Home page. + +**To log in to the Home page, do as follows:** + +
          + +
        1. Click Login. The Home page appears.
          2. + +

          To access your Home page and other application features, your profile must be complete.

          +           + +
        + +## Resetting a Forgotten Password + +While logging in, if you don't remember your password you can change it. + +To reset your password, do as follows: + + \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/manageassignedsession.mdx b/src/docusaurus/versioned_docs/version-3.1/manageassignedsession.mdx new file mode 100644 index 0000000..ccaeece --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/manageassignedsession.mdx @@ -0,0 +1,326 @@ +import Admonition from '@theme/Admonition'; +import BulkUploadTable from './_sessionbulkuploadtable.mdx'; + +# Managing Sessions Assigned to Mentors + +Session managers can carry out the following activities: + +* After publishing sessions, you can view their details such as the session's schedule, the number of enrollments, and the type of session. +* Track the session's progress using the following session statuses: + * Upcoming: The mentor is yet to host the session. + * Live: The mentor has started the session. + * Completed: The mentor completed the session. +* Update the session information. +* Delete the session. + +## Viewing the List of Published Sessions + +After publishing sessions, the list of sessions appear on the Session list section. + +**To view the Session list section, do as follows:** + +1. Do one of the following actions: + + * Select Workspace from the Application menu. + + * Go to the Application menu ![burger menu](media/burgermenu-icon.png) and select Workspace. + +2. Click **Manage sessions**. + +3. Go to the **Create sessions** tab. The Session list section appears. + +

        + +

        Click the Download link to download the session list as a CSV file.

        + +

        + + ![](media/sessionlistsection.png) + +**To find a session from the Session list section, use the following methods:** + +* Change the number of sessions listed on the page using the **Items per page** dropdown. + +* View the sessions on different pages by clicking the **Next** or **Previous** buttons. + +* Enter the session title or the mentor's name in the **Search** box and press **Enter**. + +* Filter the list using the following methods: + + 1. Click on **Filters**. + 2. Select one or more filter checkboxes and click **Apply**. + + +

        To clear filters, do one of the following actions:

        +
          +
        • Clear the specific filter checkbox.
          • +
        • Click Clear all to clear all the applied filters.
          • +
        +         + +## Tracking the Number of Enrollments + +You can view the number of mentees who have enrolled or those who were invited to the session. + +On the Session list section, do any one of the following actions: + +* View the **Mentee count** value. + + ![](media/sessionlistsection.png) + +* Click ![](media/sessionlist-view.png) and view the **Mentee count** value on the Session Details page. + + ![](media/assignedsessiondetails.png) + +## Viewing the List of Mentees + +On the Mentee list window, you can do the following actions: + +* View mentees' details. +* Check whether the mentees have enrolled for the session or have been invited to the session. + +To view the list of mentees, do any one of the following actions: + +* On the Session list section, find a session and click the **Mentee count** value. The Mentee list window appears. + +

        + +

        Click the Download link to download the mentee list as a CSV file.

        + +

        + + ![](media/menteeenrollmentlist.png) + +* Do the following actions: + + 1. On the Session list section, find a session and click ![](media/sessionlist-view.png). The Session Details page appears. + + ![](media/assignedsessiondetails.png) + + 2. Click **View list**. The Mentee list window appears. + +

        + +

        Click the Download link to download the mentee list as a CSV file.

        + +

        + + ![](media/menteeenrollmentlist.png) + +## Viewing the Mentor Profile page + +On the Mentor Profile page, you can view a mentor's details such as the number of sessions hosted and the rating received for sessions. + +To view the Mentor Profile page, click the mentor's name on the Session list section. + +![](media/portal-mentorprofilepage.png) + +## Updating Session Details + +You can edit sessions using any one of the following methods: + +* Using the Session List section +* Using Bulk Upload + +### Using the Session List Section + +To view the Edit session details page, do one of the following actions: + +* On the Session list section, click ![](media/sessionlist-edit.png). + +* Do the following actions: + + 1. On the Session list section, click ![](media/sessionlist-view.png). The Session Details page appears. + + ![](media/assignedsessiondetails.png) + + 2. Click **Edit**. + +#### Updating the Session Information + +

        + +

        You can edit the session details only until the mentor starts the session.

        + +

        + +**To edit the session information, do as follows:** + +1. On the Edit session details page, go to the Edit session tab. + +2. Make the necessary changes to: + + * The session information. + + * The list of mentees who were invited to the session. To update the list, do any one of the following actions: + + * To invite new mentees, click **+ Add New Mentee** and add mentees from the list. + * To remove mentees from the list, click the mentee's name and click **Remove** on the Mentee list window. + + * The session image. To update the session image click Add image and do one of the following actions: + + * To take a picture, select Take Photo. + * To upload an image, select Choose from library. + * To remove the existing image, select Remove current photo. + +

        + +

        Select an image that is relevant to the session topic.

        + +

        + +5. Click **Save**. The session details are updated. + +#### Updating the Meeting Information + +

        + +

        You can edit the meeting information even after the mentor has started the session.

        + +

        + +**To edit the meeting information, do as follows:** + +1. On the Edit Session Details page, go to the Meeting link tab and make the necessary changes. + +2. Click Submit. The meeting information is updated. + +### Using Bulk Upload + +To update multiple sessions, you can upload a CSV file containing the list of updates in the session or meeting information to the application. + +

        + +You can update the session or meeting information only until the scheduled start time. + +

        + +**To edit sessions using bulk upload, do as follows:** + +1. Do one of the following actions: + + * Select Workspace from the Application menu. + + * Go to the Application menu ![burger menu](media/burgermenu-icon.png) and select Workspace. + +2. Click **Manage sessions**. + +3. Go to the **Bulk upload** tab. + +4. Click **Download sample CSV** to download the sample CSV file. The downloaded sample file contains sample information that you must clear before adding the session details. + +5. Enter the details of only those sessions that need to be updated. + +

        + +

        If you had created sessions using bulk upload, open the respective CSV file.

        + +

        + +6. To update the details, do as follows: + + 1. Enter *Edit* in the **Action** column. + + 2. Enter the session ID in the **ID** column. + +

        + +

        You can find the session ID in the session list section or in the CSV file that you have received after uploading a list of sessions to the application.

        + +

        + + 3. Make the necessary changes as per the following table: + + + +3. On the **Bulk upload** tab, click **Upload CSV** and select the CSV file containing the edited session details. The session details are updated. + +

        + +

        After updating sessions, you will receive a CSV file in your email that displays details such as:

        +
          +
        • ID
          • +
        • Session status (Valid or Invalid)
          • +
        • Status message
          • +
        +

        If the details entered in the uploaded CSV need corrections, the session status would be invalid and the session is not updated. In such cases, refer to the status message and upload the respective file with the updated details.

        To make the necessary updates, see the Troubleshooting Invalid Messages section.

        + +

        + +## Deleting Sessions + +You can delete sessions using any one of the following methods: + +* Using the Session List section +* Using Bulk Upload + + +

        You can delete the session only until the mentor starts the session.

        +         + +### Using the Session List Section + +1. To delete the session, do one of the following actions: + + * On the Session List section, click ![](media/sessionlist-delete.png). + + * Do the following actions: + + 1. On the Session List section, click ![](media/sessionlist-view.png). The Session Details page appears. + + ![](media/assignedsessiondetails.png) + + 2. Click **Delete**. + +2. Click Yes delete on the confirmation dialog. The session is cancelled and is removed from the Session list section. + +### Using Bulk Upload + +To delete multiple sessions, you can upload a CSV file containing the list of sessions to be deleted to the application. + +1. Do one of the following actions: + + * Select Workspace from the Application menu. + + * Go to the Application menu ![burger menu](media/burgermenu-icon.png) and select Workspace. + +2. Go to the **Bulk upload** tab. + +3. Click **Download sample CSV** to download the sample CSV file. The downloaded sample file contains information that you must clear before adding the session details. + +

        + +

        If you had created sessions using bulk upload, open the respective CSV file.

        + +

        + +5. Do as follows: + + 1. Enter *Delete* in the **Action** column. + + 2. In the **ID** column, enter the session IDs of the session that you want to delete. + +

        + +

        You can find the session ID in the session list section or in the CSV file that you have received after uploading a list of sessions to the application.

        + +

        +

        + +

        The file must include only those sessions that should be deleted from the application.

        + +

        + +3. On the **Bulk upload** tab, click **Upload CSV** and select the CSV file containing the list of sessions to be deleted. The session is removed from Session list section. + +

        + +

        After deleting sessions, you will receive a CSV file in your email that displays details such as:

        +
          +
        • ID
          • +
        • Session status (Valid or Invalid)
          • +
        • Status message
          • +
        +

        If the details entered in the uploaded CSV are incorrect, the session status would be invalid and the session will not be deleted. In such cases, refer to the status message and upload the respective file with the correct details

        To make the necessary updates, see the Troubleshooting Invalid Messages section.

        + +

        \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/managementorrequests.mdx b/src/docusaurus/versioned_docs/version-3.1/managementorrequests.mdx new file mode 100644 index 0000000..b997ea8 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/managementorrequests.mdx @@ -0,0 +1,27 @@ +# Managing Requests to Become a Mentor + +After mentees raise a request to become a mentor, the organization administrator can review their profile details and accept or reject the request. + +**To accept requests to become a mentor, do as follows:** + +1. Do one of the following actions: + * Select **Workspace** from the **Application** menu. + * Go to the **Application** menu ![burger menu](media/burgermenu-icon.png) and select **Workspace**. + +2. On the Workspace page, click **Manage user**. The Manage user page appears. + + ![](media/orgadmin-managerequests.png) + +4. On the Manage Request tab, do one of the following actions: + + * To review the profile details, click **View** ![](media/orgadmin-viewmentordetails.png). + + * To accept the request, do as follows: + 1. Click **Accept** ![](media/orgadmin-acceptmentor.png). + 2. Click **Yes** in the confirmation dialog. + + * To reject the request, do as follows: + 1. Click **Reject** ![](media/orgadmin-rejectmentor.png). + 2. Click **Yes** in the confirmation dialog. + + diff --git a/src/docusaurus/versioned_docs/version-3.1/media/addmeetinglink.png b/src/docusaurus/versioned_docs/version-3.1/media/addmeetinglink.png new file mode 100644 index 0000000..7de8129 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/addmeetinglink.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/architecture.png b/src/docusaurus/versioned_docs/version-3.1/media/architecture.png new file mode 100644 index 0000000..858eb76 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/architecture.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/architecture.svg b/src/docusaurus/versioned_docs/version-3.1/media/architecture.svg new file mode 100644 index 0000000..8014da2 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/media/architecture.svg @@ -0,0 +1,4 @@ + + + +
        Reporting Service
        Reporting...
        Mentees
        Mentees
                   Mentors
        ...
        Mentor
        Progressive Web App (PWA)
        Mentor...
        User Service
        User Service
          Notification Service
        Notifica...
        Supporting Microservices (Optional)
        Supporting Microservices (Optional)
        Scheduler Service
        Scheduler...
        Interface Service
        Interface Ser...
        BigBlueButton™ Service
        BigBlueButto...









        Mentor Service
        Mentor Servi...






        PostgreSQL
        PostgreSQL...
        HTTP
        Request
        HTTP...
        HTTP
         Request
        HTTP...
        HTTP
        Response
        HTTP...
        HTTP
        Response
        HTTP...        Text is not SVG - cannot display         \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/media/assignedsessiondetails.png b/src/docusaurus/versioned_docs/version-3.1/media/assignedsessiondetails.png new file mode 100644 index 0000000..a9e1676 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/assignedsessiondetails.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/assignedsessiondetailsstart.png b/src/docusaurus/versioned_docs/version-3.1/media/assignedsessiondetailsstart.png new file mode 100644 index 0000000..38f4397 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/assignedsessiondetailsstart.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/assignedsessiontile.png b/src/docusaurus/versioned_docs/version-3.1/media/assignedsessiontile.png new file mode 100644 index 0000000..883d76a Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/assignedsessiontile.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/assignsession.png b/src/docusaurus/versioned_docs/version-3.1/media/assignsession.png new file mode 100644 index 0000000..612d7ce Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/assignsession.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/becomeamentor-page.png b/src/docusaurus/versioned_docs/version-3.1/media/becomeamentor-page.png new file mode 100644 index 0000000..f9fee6a Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/becomeamentor-page.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/burgermenu-icon.png b/src/docusaurus/versioned_docs/version-3.1/media/burgermenu-icon.png new file mode 100644 index 0000000..443da8f Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/burgermenu-icon.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/cancel-enrollment.png b/src/docusaurus/versioned_docs/version-3.1/media/cancel-enrollment.png new file mode 100644 index 0000000..eede2a4 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/cancel-enrollment.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/categoryandmedium.png b/src/docusaurus/versioned_docs/version-3.1/media/categoryandmedium.png new file mode 100644 index 0000000..253c94e Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/categoryandmedium.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/changepassword.png b/src/docusaurus/versioned_docs/version-3.1/media/changepassword.png new file mode 100644 index 0000000..4b0a8d9 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/changepassword.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/changeroletomentor.png b/src/docusaurus/versioned_docs/version-3.1/media/changeroletomentor.png new file mode 100644 index 0000000..b4f7f5c Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/changeroletomentor.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/changeroletosm.png b/src/docusaurus/versioned_docs/version-3.1/media/changeroletosm.png new file mode 100644 index 0000000..6ed45cc Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/changeroletosm.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/copyicon.png b/src/docusaurus/versioned_docs/version-3.1/media/copyicon.png new file mode 100644 index 0000000..a9d5a21 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/copyicon.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/create_session.png b/src/docusaurus/versioned_docs/version-3.1/media/create_session.png new file mode 100644 index 0000000..51fc3dc Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/create_session.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/createprofile-options.png b/src/docusaurus/versioned_docs/version-3.1/media/createprofile-options.png new file mode 100644 index 0000000..525b332 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/createprofile-options.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/createsession-options.png b/src/docusaurus/versioned_docs/version-3.1/media/createsession-options.png new file mode 100644 index 0000000..803f0fb Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/createsession-options.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/dashboard-icon.png b/src/docusaurus/versioned_docs/version-3.1/media/dashboard-icon.png new file mode 100644 index 0000000..f103a0d Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/dashboard-icon.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/db-mentor.png b/src/docusaurus/versioned_docs/version-3.1/media/db-mentor.png new file mode 100644 index 0000000..f986795 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/db-mentor.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/delete-pastsessions.PNG b/src/docusaurus/versioned_docs/version-3.1/media/delete-pastsessions.PNG new file mode 100644 index 0000000..8e9e077 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/delete-pastsessions.PNG differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/edit-session.PNG b/src/docusaurus/versioned_docs/version-3.1/media/edit-session.PNG new file mode 100644 index 0000000..e249df4 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/edit-session.PNG differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/editmenteeprofile.png b/src/docusaurus/versioned_docs/version-3.1/media/editmenteeprofile.png new file mode 100644 index 0000000..95a5c5c Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/editmenteeprofile.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/editmentorprofile.png b/src/docusaurus/versioned_docs/version-3.1/media/editmentorprofile.png new file mode 100644 index 0000000..09de444 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/editmentorprofile.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/enrollbutton.png b/src/docusaurus/versioned_docs/version-3.1/media/enrollbutton.png new file mode 100644 index 0000000..7b09fb8 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/enrollbutton.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/faq.png b/src/docusaurus/versioned_docs/version-3.1/media/faq.png new file mode 100644 index 0000000..b9a0356 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/faq.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/feedbackform-host.png b/src/docusaurus/versioned_docs/version-3.1/media/feedbackform-host.png new file mode 100644 index 0000000..c4e82f0 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/feedbackform-host.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/feedbackform-participant.png b/src/docusaurus/versioned_docs/version-3.1/media/feedbackform-participant.png new file mode 100644 index 0000000..ab8211c Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/feedbackform-participant.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/help.png b/src/docusaurus/versioned_docs/version-3.1/media/help.png new file mode 100644 index 0000000..ce7e0ed Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/help.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/helpvideos.png b/src/docusaurus/versioned_docs/version-3.1/media/helpvideos.png new file mode 100644 index 0000000..3600fb4 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/helpvideos.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/intro.png b/src/docusaurus/versioned_docs/version-3.1/media/intro.png new file mode 100644 index 0000000..a916dc3 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/intro.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/invitedsessiondetailsjoin.png b/src/docusaurus/versioned_docs/version-3.1/media/invitedsessiondetailsjoin.png new file mode 100644 index 0000000..b0fc093 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/invitedsessiondetailsjoin.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/invitedsessiontile.png b/src/docusaurus/versioned_docs/version-3.1/media/invitedsessiontile.png new file mode 100644 index 0000000..dd21582 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/invitedsessiontile.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/joinbutton.png b/src/docusaurus/versioned_docs/version-3.1/media/joinbutton.png new file mode 100644 index 0000000..59ffd1b Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/joinbutton.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/languagesettings.png b/src/docusaurus/versioned_docs/version-3.1/media/languagesettings.png new file mode 100644 index 0000000..b70940f Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/languagesettings.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/loginactivity.png b/src/docusaurus/versioned_docs/version-3.1/media/loginactivity.png new file mode 100644 index 0000000..9f8f7c3 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/loginactivity.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/loginpage.png b/src/docusaurus/versioned_docs/version-3.1/media/loginpage.png new file mode 100644 index 0000000..3cd4876 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/loginpage.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/mentee-dashboard.PNG b/src/docusaurus/versioned_docs/version-3.1/media/mentee-dashboard.PNG new file mode 100644 index 0000000..a61049a Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/mentee-dashboard.PNG differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/mentee-deleteaccount.png b/src/docusaurus/versioned_docs/version-3.1/media/mentee-deleteaccount.png new file mode 100644 index 0000000..221894a Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/mentee-deleteaccount.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/mentee-homepage.png b/src/docusaurus/versioned_docs/version-3.1/media/mentee-homepage.png new file mode 100644 index 0000000..5cbdfac Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/mentee-homepage.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/menteedashboard.png b/src/docusaurus/versioned_docs/version-3.1/media/menteedashboard.png new file mode 100644 index 0000000..d09b944 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/menteedashboard.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/menteeenrollmentlist.png b/src/docusaurus/versioned_docs/version-3.1/media/menteeenrollmentlist.png new file mode 100644 index 0000000..a546457 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/menteeenrollmentlist.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/menteelistwindow.png b/src/docusaurus/versioned_docs/version-3.1/media/menteelistwindow.png new file mode 100644 index 0000000..264f968 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/menteelistwindow.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/menteesessiondetails.png b/src/docusaurus/versioned_docs/version-3.1/media/menteesessiondetails.png new file mode 100644 index 0000000..21633d7 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/menteesessiondetails.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/mentor-dashboard.PNG b/src/docusaurus/versioned_docs/version-3.1/media/mentor-dashboard.PNG new file mode 100644 index 0000000..146946f Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/mentor-dashboard.PNG differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/mentor-deleteaccount.png b/src/docusaurus/versioned_docs/version-3.1/media/mentor-deleteaccount.png new file mode 100644 index 0000000..87707f0 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/mentor-deleteaccount.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/mentor-homepage.png b/src/docusaurus/versioned_docs/version-3.1/media/mentor-homepage.png new file mode 100644 index 0000000..f4e199a Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/mentor-homepage.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/mentordashboard.png b/src/docusaurus/versioned_docs/version-3.1/media/mentordashboard.png new file mode 100644 index 0000000..28c6ca9 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/mentordashboard.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/mentordirectory-icon.PNG b/src/docusaurus/versioned_docs/version-3.1/media/mentordirectory-icon.PNG new file mode 100644 index 0000000..c7a3911 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/mentordirectory-icon.PNG differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/mentordirectory-upcomingsessions.png b/src/docusaurus/versioned_docs/version-3.1/media/mentordirectory-upcomingsessions.png new file mode 100644 index 0000000..324e548 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/mentordirectory-upcomingsessions.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/mentored-architecturediagram.png b/src/docusaurus/versioned_docs/version-3.1/media/mentored-architecturediagram.png new file mode 100644 index 0000000..45f982f Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/mentored-architecturediagram.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/mentorlistwindow.png b/src/docusaurus/versioned_docs/version-3.1/media/mentorlistwindow.png new file mode 100644 index 0000000..c36cac9 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/mentorlistwindow.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/mentorprofile-enroll.png b/src/docusaurus/versioned_docs/version-3.1/media/mentorprofile-enroll.png new file mode 100644 index 0000000..e7f141b Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/mentorprofile-enroll.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/mentorprofile-join.png b/src/docusaurus/versioned_docs/version-3.1/media/mentorprofile-join.png new file mode 100644 index 0000000..8c05cdd Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/mentorprofile-join.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/mentorprofile-upcomingsessions.png b/src/docusaurus/versioned_docs/version-3.1/media/mentorprofile-upcomingsessions.png new file mode 100644 index 0000000..3141077 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/mentorprofile-upcomingsessions.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/mentorprofilepage.png b/src/docusaurus/versioned_docs/version-3.1/media/mentorprofilepage.png new file mode 100644 index 0000000..083e8eb Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/mentorprofilepage.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/mentorsessiondetails.png b/src/docusaurus/versioned_docs/version-3.1/media/mentorsessiondetails.png new file mode 100644 index 0000000..6658052 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/mentorsessiondetails.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/mobileoverview.mp4 b/src/docusaurus/versioned_docs/version-3.1/media/mobileoverview.mp4 new file mode 100644 index 0000000..4796b99 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/mobileoverview.mp4 differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/newsession.png b/src/docusaurus/versioned_docs/version-3.1/media/newsession.png new file mode 100644 index 0000000..7fa35a2 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/newsession.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/openwith-options.png b/src/docusaurus/versioned_docs/version-3.1/media/openwith-options.png new file mode 100644 index 0000000..5e74d93 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/openwith-options.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/orgadmin-acceptmentor.png b/src/docusaurus/versioned_docs/version-3.1/media/orgadmin-acceptmentor.png new file mode 100644 index 0000000..9766372 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/orgadmin-acceptmentor.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/orgadmin-bulkupload.png b/src/docusaurus/versioned_docs/version-3.1/media/orgadmin-bulkupload.png new file mode 100644 index 0000000..f30d856 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/orgadmin-bulkupload.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/orgadmin-managerequests.png b/src/docusaurus/versioned_docs/version-3.1/media/orgadmin-managerequests.png new file mode 100644 index 0000000..240d47f Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/orgadmin-managerequests.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/orgadmin-rejectmentor.png b/src/docusaurus/versioned_docs/version-3.1/media/orgadmin-rejectmentor.png new file mode 100644 index 0000000..e8f2c20 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/orgadmin-rejectmentor.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/orgadmin-viewmentordetails.png b/src/docusaurus/versioned_docs/version-3.1/media/orgadmin-viewmentordetails.png new file mode 100644 index 0000000..365f8a4 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/orgadmin-viewmentordetails.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/orgadminpage.png b/src/docusaurus/versioned_docs/version-3.1/media/orgadminpage.png new file mode 100644 index 0000000..800b039 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/orgadminpage.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/other.png b/src/docusaurus/versioned_docs/version-3.1/media/other.png new file mode 100644 index 0000000..bb9b255 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/other.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/otheroptionadded.png b/src/docusaurus/versioned_docs/version-3.1/media/otheroptionadded.png new file mode 100644 index 0000000..b8e6a39 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/otheroptionadded.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-addmeetinglink.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-addmeetinglink.png new file mode 100644 index 0000000..8dc44ec Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-addmeetinglink.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-applicationmenumentors.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-applicationmenumentors.png new file mode 100644 index 0000000..4bc9648 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-applicationmenumentors.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-cancelenrollment.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-cancelenrollment.png new file mode 100644 index 0000000..9d6927e Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-cancelenrollment.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-createprofileoptions.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-createprofileoptions.png new file mode 100644 index 0000000..14b639a Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-createprofileoptions.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-createsession.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-createsession.png new file mode 100644 index 0000000..f646ee9 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-createsession.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-createsessionoptions.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-createsessionoptions.png new file mode 100644 index 0000000..62dd350 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-createsessionoptions.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-editmenteeprofile.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-editmenteeprofile.png new file mode 100644 index 0000000..3cc446e Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-editmenteeprofile.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-editmentorprofile.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-editmentorprofile.png new file mode 100644 index 0000000..59bca76 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-editmentorprofile.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-editsession.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-editsession.png new file mode 100644 index 0000000..bd36541 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-editsession.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-enrollbutton.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-enrollbutton.png new file mode 100644 index 0000000..bbff086 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-enrollbutton.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-faq.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-faq.png new file mode 100644 index 0000000..0fae749 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-faq.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-help.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-help.png new file mode 100644 index 0000000..0778d56 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-help.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-helpvideos.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-helpvideos.png new file mode 100644 index 0000000..86ad965 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-helpvideos.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-hostfeedback.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-hostfeedback.png new file mode 100644 index 0000000..893483c Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-hostfeedback.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-joinbutton.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-joinbutton.png new file mode 100644 index 0000000..1d71738 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-joinbutton.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-languagesettings.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-languagesettings.png new file mode 100644 index 0000000..14de292 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-languagesettings.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-loginpage.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-loginpage.png new file mode 100644 index 0000000..f291a79 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-loginpage.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-menteeapplicationmenu.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-menteeapplicationmenu.png new file mode 100644 index 0000000..5c59345 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-menteeapplicationmenu.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-menteedashboard.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-menteedashboard.png new file mode 100644 index 0000000..1784242 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-menteedashboard.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-menteedeleteaccount.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-menteedeleteaccount.png new file mode 100644 index 0000000..10eb246 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-menteedeleteaccount.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-menteehomepage.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-menteehomepage.png new file mode 100644 index 0000000..c7ed543 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-menteehomepage.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-mentorapplicationmenu.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-mentorapplicationmenu.png new file mode 100644 index 0000000..322548c Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-mentorapplicationmenu.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-mentordashboard.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-mentordashboard.png new file mode 100644 index 0000000..35204a1 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-mentordashboard.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-mentordeleteaccount.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-mentordeleteaccount.png new file mode 100644 index 0000000..b07caba Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-mentordeleteaccount.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-mentordirectory-upcomingsessions.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-mentordirectory-upcomingsessions.png new file mode 100644 index 0000000..57ceeb1 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-mentordirectory-upcomingsessions.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-mentorhomepage.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-mentorhomepage.png new file mode 100644 index 0000000..3d7df56 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-mentorhomepage.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-mentorprofileenroll.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-mentorprofileenroll.png new file mode 100644 index 0000000..7a51141 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-mentorprofileenroll.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-mentorprofilejoin.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-mentorprofilejoin.png new file mode 100644 index 0000000..e28bea6 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-mentorprofilejoin.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-mentorprofilepage.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-mentorprofilepage.png new file mode 100644 index 0000000..1c3ae9f Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-mentorprofilepage.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-newsession.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-newsession.png new file mode 100644 index 0000000..6282a53 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-newsession.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-participantfeedback.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-participantfeedback.png new file mode 100644 index 0000000..3c843e0 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-participantfeedback.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-searchsessions.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-searchsessions.png new file mode 100644 index 0000000..c60de82 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-searchsessions.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-sessiondetailsenroll.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-sessiondetailsenroll.png new file mode 100644 index 0000000..8331899 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-sessiondetailsenroll.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-sessiondetailsjoin.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-sessiondetailsjoin.png new file mode 100644 index 0000000..465752e Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-sessiondetailsjoin.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-sessiondetailsstart.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-sessiondetailsstart.png new file mode 100644 index 0000000..8c91020 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-sessiondetailsstart.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-sessiontileenroll.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-sessiontileenroll.png new file mode 100644 index 0000000..80fe0fd Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-sessiontileenroll.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-sessiontilejoin.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-sessiontilejoin.png new file mode 100644 index 0000000..086a040 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-sessiontilejoin.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-startbutton.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-startbutton.png new file mode 100644 index 0000000..2a81139 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-startbutton.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portal-welcome.png b/src/docusaurus/versioned_docs/version-3.1/media/portal-welcome.png new file mode 100644 index 0000000..c7ed543 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portal-welcome.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/portaloverview.mp4 b/src/docusaurus/versioned_docs/version-3.1/media/portaloverview.mp4 new file mode 100644 index 0000000..5b151e6 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/portaloverview.mp4 differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/profile-icon.png b/src/docusaurus/versioned_docs/version-3.1/media/profile-icon.png new file mode 100644 index 0000000..580e397 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/profile-icon.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/recommendedcategorymedium.png b/src/docusaurus/versioned_docs/version-3.1/media/recommendedcategorymedium.png new file mode 100644 index 0000000..a9bfce7 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/recommendedcategorymedium.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/recommendedfor.png b/src/docusaurus/versioned_docs/version-3.1/media/recommendedfor.png new file mode 100644 index 0000000..d6d9a17 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/recommendedfor.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/saasarchitecture.png b/src/docusaurus/versioned_docs/version-3.1/media/saasarchitecture.png new file mode 100644 index 0000000..7e4df93 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/saasarchitecture.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/search-sessions.png b/src/docusaurus/versioned_docs/version-3.1/media/search-sessions.png new file mode 100644 index 0000000..1f9b536 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/search-sessions.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/searchmentors.png b/src/docusaurus/versioned_docs/version-3.1/media/searchmentors.png new file mode 100644 index 0000000..df1460e Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/searchmentors.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/selectdateandtime.png b/src/docusaurus/versioned_docs/version-3.1/media/selectdateandtime.png new file mode 100644 index 0000000..5681763 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/selectdateandtime.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/selectdaterange.png b/src/docusaurus/versioned_docs/version-3.1/media/selectdaterange.png new file mode 100644 index 0000000..a76e1a3 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/selectdaterange.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/selectedrecommends.png b/src/docusaurus/versioned_docs/version-3.1/media/selectedrecommends.png new file mode 100644 index 0000000..2567a2c Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/selectedrecommends.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/sessiondetailsenroll.png b/src/docusaurus/versioned_docs/version-3.1/media/sessiondetailsenroll.png new file mode 100644 index 0000000..3a535e6 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/sessiondetailsenroll.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/sessiondetailsjoin.png b/src/docusaurus/versioned_docs/version-3.1/media/sessiondetailsjoin.png new file mode 100644 index 0000000..c82fdb4 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/sessiondetailsjoin.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/sessionlist-delete.png b/src/docusaurus/versioned_docs/version-3.1/media/sessionlist-delete.png new file mode 100644 index 0000000..457c18f Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/sessionlist-delete.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/sessionlist-edit.png b/src/docusaurus/versioned_docs/version-3.1/media/sessionlist-edit.png new file mode 100644 index 0000000..4b93f68 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/sessionlist-edit.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/sessionlist-view.png b/src/docusaurus/versioned_docs/version-3.1/media/sessionlist-view.png new file mode 100644 index 0000000..83e608b Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/sessionlist-view.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/sessionlistsection.png b/src/docusaurus/versioned_docs/version-3.1/media/sessionlistsection.png new file mode 100644 index 0000000..4f00055 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/sessionlistsection.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/sessionmanagerpage.png b/src/docusaurus/versioned_docs/version-3.1/media/sessionmanagerpage.png new file mode 100644 index 0000000..78933c7 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/sessionmanagerpage.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/sessiontile-enroll.png b/src/docusaurus/versioned_docs/version-3.1/media/sessiontile-enroll.png new file mode 100644 index 0000000..3d0f482 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/sessiontile-enroll.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/sessiontile-join.png b/src/docusaurus/versioned_docs/version-3.1/media/sessiontile-join.png new file mode 100644 index 0000000..7e46da4 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/sessiontile-join.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/share-icon.png b/src/docusaurus/versioned_docs/version-3.1/media/share-icon.png new file mode 100644 index 0000000..168ca36 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/share-icon.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/shareprofile.png b/src/docusaurus/versioned_docs/version-3.1/media/shareprofile.png new file mode 100644 index 0000000..2d601d6 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/shareprofile.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/sharesession-host.png b/src/docusaurus/versioned_docs/version-3.1/media/sharesession-host.png new file mode 100644 index 0000000..8c5a32a Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/sharesession-host.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/sharesession-participant.png b/src/docusaurus/versioned_docs/version-3.1/media/sharesession-participant.png new file mode 100644 index 0000000..5dbf016 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/sharesession-participant.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/smdashboard.png b/src/docusaurus/versioned_docs/version-3.1/media/smdashboard.png new file mode 100644 index 0000000..e52a62e Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/smdashboard.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/smsessiondetails.png b/src/docusaurus/versioned_docs/version-3.1/media/smsessiondetails.png new file mode 100644 index 0000000..3c35122 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/smsessiondetails.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/sorticon.png b/src/docusaurus/versioned_docs/version-3.1/media/sorticon.png new file mode 100644 index 0000000..795a68c Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/sorticon.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/splash.jpg b/src/docusaurus/versioned_docs/version-3.1/media/splash.jpg new file mode 100644 index 0000000..5c94294 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/splash.jpg differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/startbutton.png b/src/docusaurus/versioned_docs/version-3.1/media/startbutton.png new file mode 100644 index 0000000..891644d Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/startbutton.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/startsession.png b/src/docusaurus/versioned_docs/version-3.1/media/startsession.png new file mode 100644 index 0000000..7dfa719 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/startsession.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/viewroles-mentee.png b/src/docusaurus/versioned_docs/version-3.1/media/viewroles-mentee.png new file mode 100644 index 0000000..e5c17d1 Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/viewroles-mentee.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/viewroles-mentor.png b/src/docusaurus/versioned_docs/version-3.1/media/viewroles-mentor.png new file mode 100644 index 0000000..21f39cf Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/viewroles-mentor.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/media/welcome.png b/src/docusaurus/versioned_docs/version-3.1/media/welcome.png new file mode 100644 index 0000000..5cbdfac Binary files /dev/null and b/src/docusaurus/versioned_docs/version-3.1/media/welcome.png differ diff --git a/src/docusaurus/versioned_docs/version-3.1/mentee-deleteaccountrequest.mdx b/src/docusaurus/versioned_docs/version-3.1/mentee-deleteaccountrequest.mdx new file mode 100644 index 0000000..5f33c96 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/mentee-deleteaccountrequest.mdx @@ -0,0 +1,34 @@ +import PartialExample from './_mentored.mdx'; +import BurgerMenu from './media/burgermenu-icon.png' +import PortalMenteeDeleteAccount from './media/portal-menteedeleteaccount.png' +import Admonition from '@theme/Admonition'; + +# Deleting a Mentee Account + +You can create a request to delete the account. After the request is accepted, you will lose access to your account. + +In addition to this, the following actions take place: + +* Your enrollment to sessions are cancelled. +* You cannot enroll for a new session. + + +

        You can reuse the deleted account's credentials if you wish to register again as a new user in future.

        +         + +**To create a request to delete your account, do as follows:** + +
          +
        1. Do one of the following actions:
          2. +
            +
          • Select Help from the Application menu.
            • +
          • Go to the Application menu and select Help.
            • +
          +
        2. On the Help page, select Request to delete my account option from the help menu.
          3. +

          + +

          +
        3. Optionally, to specify the reason for deleting the account, enter the reason in the Reason for deleting account box.
          4. +
        4. Click Delete account.
          5. +
        5. Click Yes on the confirmation dialog. A request to delete the account is created.
          6. +
        \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/mentor-deleteaccountrequest.mdx b/src/docusaurus/versioned_docs/version-3.1/mentor-deleteaccountrequest.mdx new file mode 100644 index 0000000..b8db7f8 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/mentor-deleteaccountrequest.mdx @@ -0,0 +1,34 @@ +import PartialExample from './_mentored.mdx'; +import BurgerMenu from './media/burgermenu-icon.png' +import PortalMentorDeleteAccount from './media/portal-mentordeleteaccount.png' +import Admonition from '@theme/Admonition'; + +# Deleting a Mentor Account + +You can create a request to delete the account. After the request is accepted, you will lose access to your account. + +In addition to this, the following actions take place: + +* Your profile is removed from the Mentor Directory. +* The sessions that you have created are deleted. + + +

        You can reuse the deleted account's credentials if you wish to register again as a new user in future.

        +         + +**To create a request to delete your account, do as follows:** + +
          +
        1. Do one of the following actions:
          2. +
            +
          • Select Help from the Application menu.
            • +
          • Go to the Application menu and select Help.
            • +
          +
        2. On the Help page, select Request to delete my account option from the help menu.
          3. +

          + +

          +
        3. Optionally, to specify the reason for deleting the account, enter the reason in the Reason for deleting account box.
          4. +
        4. Click Delete account.
          5. +
        5. Click Yes on the confirmation dialog. A request to delete the account is created.
          6. +
        \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/mentor-directory.mdx b/src/docusaurus/versioned_docs/version-3.1/mentor-directory.mdx new file mode 100644 index 0000000..ae6c609 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/mentor-directory.mdx @@ -0,0 +1,121 @@ +import PartialExample from './_mentored.mdx'; +import Admonition from '@theme/Admonition'; + +# Mentor Directory + +The Mentor Directory lists mentor profiles in an alphabetical order. Using the Mentor Directory, you can discover mentors in your chosen area of expertise and view their mentor profile. + +To view the Mentor Directory, do any one of the following actions: + +* Select **Mentors** from the **Application** menu. + +* Go to the **Application** menu ![](media/burgermenu-icon.png) and select **Mentors**. + + ![](media/portal-applicationmenumentors.png) + +* Go to the Mentors tab. + + ![](media/mentordirectory-icon.PNG) + +## Finding Mentors Using the Search Box + +To find mentors on the Mentor Directory, enter a keyword such as the mentor's name or the area of expertise in the **Search** box and press **Enter**. The search results appear as mentor profile tiles. + +
        + +To refine your search results, you can also search for mentors based on a specific category. Click here for the following actions: + +1. To specify the search category, refer to the following table: + + + + + + + + + + + + + + +
        CategoryActions
        Search CategoryClick the Search box and select a search category such as Area of Expertise.
        Filter
        1. Click on Filter.
        2. Select one or more filters and click Apply.

          3. To clear filters, do one of the following actions:

          • Clear the filter checkbox.
          • Click Clear all to clear all the applied filters.
        + +2. Enter the search keyword. Based on the selected category, the search results appear as mentor profile tiles. + + ![](media/searchmentors.png) + +
        + + +

        From the search results, you can find the respective mentor using the following ways:

        +
          +
        • Viewing the search results on different pages by clicking the Next or Previous buttons.
          • +
        • Changing the number of search results listed on the page using the Items per page dropdown.
          • +
        • Applying filters. To learn more, refer to the category-based search instructions.
          • +
        +         + +## Viewing the Mentor Profile + +On the Mentor Profile page, you can do the following actions: + +* View the number of sessions conducted by the mentor. + +* View the ratings they received for sessions. + +* View the additional roles assigned to the mentor. + +* Discover the upcoming sessions of the mentor. + +* Enroll and join sessions. + +* Share a mentor profile using a link. + +**To view the Mentor Profile page, do as follows:** + +1. On the Mentor Directory, find a mentor and click the mentor profile tile. + +2. Go to the About tab to view the profile details. + + ![](media/portal-mentorprofilepage.png) + +### Viewing Roles Assigned to a Mentor + +You can view the list of additional roles (such as session manager or organization administrator) that are assigned to a mentor by an organization. + + +

        Every user who registers on the platform is a mentee by default.

        +         + +To view the list of assigned roles, click the **View roles** link on the Mentor Profile page. + +![](media/portal-mentorprofilepage.png) + +### Finding the Upcoming Sessions of the Mentor + +On the Mentor Profile page, go to the Upcoming sessions tab to view the sessions. + +![](media/portal-mentordirectory-upcomingsessions.png) + + +

        To learn more about enrolling and joining sessions using the mentor profile, see the following topics:

        + +         + +### Sharing Mentor Profile Links + +You can share mentor profile links with your contacts. + +**To share mentor profile links, do as follows:** + +1. On the Mentor profile page, click **Share profile** to copy the mentor profile link. + +2. Share the mentor profile link with your contacts. + + ![](media/portal-mentorprofilepage.png) + diff --git a/src/docusaurus/versioned_docs/version-3.1/notifications.mdx b/src/docusaurus/versioned_docs/version-3.1/notifications.mdx new file mode 100644 index 0000000..5443a76 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/notifications.mdx @@ -0,0 +1,42 @@ +import PartialExample from './_mentored.mdx'; +import Admonition from '@theme/Admonition'; + +# Notifications + +Mentors will receive email notifications: + +* When a session manager: + * Assigns them a Public or Private session. + * Updates the session details. Mentors will receive email notifications containing the revised session details. + * Cancels the session. +* To remind them to host their upcoming sessions. + +Mentees will receive email notifications: + +* When an organization administrator accepts or rejects their request to become a mentor. +* When they enroll for a session or unenroll from a session. +* When the mentor updates the session schedule or details. +* When the mentor cancels the session. +* When a session manager: + * Invites them for a session. + * Updates the session details. Mentees will receive email notifications containing the revised session details. + * Cancels the session. +* To remind them to join the enrolled or invited sessions. +* When the enrollment to sessions is cancelled after account deletion. + +Organization administrators will receive an email notification after they upload a list of users to the application. In the email notification, they can view the CSV file containing the following information about the listed users: + +* Assigned user ID +* Whether the user uploaded to the application already exists + +Session managers would receive an email notification after they create, edit, or delete sessions using bulk upload. In the email notification, they can view the CSV file containing the following information about the listed sessions: + +* Session ID +* Session status (Valid, Invalid, or Published) +* Session status message + + + + + + diff --git a/src/docusaurus/versioned_docs/version-3.1/policyarchitecture.mdx b/src/docusaurus/versioned_docs/version-3.1/policyarchitecture.mdx new file mode 100644 index 0000000..642c18e --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/policyarchitecture.mdx @@ -0,0 +1,61 @@ +import Admonition from '@theme/Admonition'; +import PartialExample from './_mentored.mdx'; + +# About Organizational Rules and Policies + +If has a multi-tenant architecture, each organization can do the following actions: + +* Set policies to manage access to mentees, mentors, and sessions across organizations. + +* Set rules for mentor and session discovery within the organization. + +

        + +

        See About Organizations to learn more about implementing the multi-tenant architecture using the User service.

        + +

        + +## Policy Architecture + +Organization administrators can use policies to manage access to mentees, mentors, and sessions across organizations. + +

        + +

        To learn more about configuring policies for an organization, see Setting Policies for an Organization Using APIs.

        + +

        + + + + + + + + + + + + + + + + + + +
        Types of PoliciesDescription
        All

        If the policy is set to All, the organization’s mentees, mentors, or sessions can be accessed by other organizations. Similarly, the organization’s users can access mentees, mentors, or sessions of other organizations.

        Restrictions set by other organizations will be applicable for users.

        Current

        If the policy is set to Current, only users belonging to the organization can access the mentors, mentees, or sessions. Similarly, the organization’s users cannot access mentees, mentors, or sessions of other organizations.

        Associated

        The Associated policy provides users with access to mentors, mentees, or sessions across multiple organizations.

        For example, if organizations A and B are linked with the Associated policy, only users belonging to these two organizations can access the mentors, mentees, or sessions of both organizations.

        + +## Rules for Mentor and Session Discovery + +Organization administrators can set rules to allow users within the organization to connect and seek mentorship opportunities. + +Examples: + +* If the platform contains sessions on communication, users seeking improvements in this domain can connect and seek guidance from each other. + +* If there are sessions hosted in multiple languages, users with similar language preferences can connect and seek guidance from each other. + +

        + +

        See Setting Rules for Mentor and Session Discovery to learn more.

        + +

        \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/report-an-issue.mdx b/src/docusaurus/versioned_docs/version-3.1/report-an-issue.mdx new file mode 100644 index 0000000..b74917c --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/report-an-issue.mdx @@ -0,0 +1,24 @@ +import PartialExample from './_mentored.mdx'; +import BurgerMenu from './media/burgermenu-icon.png' +import PortalHelp from './media/portal-help.png' +import Admonition from '@theme/Admonition'; + +# Reporting an Issue + +You can write to the support team about any problems you faced while using the application. + +**To report an issue, do as follows:** + +
          +
        1. Do one of the following actions:
          2. +
            +
          • Select Help from the Application menu.
            • +
          • Go to the Application menu and select Help.
            • +
          +
        2. On the Help page, select Report an issue option from the help menu.
          3. +
        3. Enter the details of the issue you faced in the Report an issue box.
          4. +

          + +

          +
        4. Click Submit. Your issue is reported successfully.
          5. +
        diff --git a/src/docusaurus/versioned_docs/version-3.1/report-signuporloginissue.mdx b/src/docusaurus/versioned_docs/version-3.1/report-signuporloginissue.mdx new file mode 100644 index 0000000..105a026 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/report-signuporloginissue.mdx @@ -0,0 +1,17 @@ +import PartialExample from './_mentored.mdx'; +import PortalLoginPage from './media/portal-loginpage.png' +import Admonition from '@theme/Admonition'; + +# Reporting Sign up and Log in Issues + +You can write to the support team about any problems you faced while signing up or logging in to . + +**To report issues related to signing up and logging in, do as follows:** + +
          +
        1. On the Login page, copy the support team's email ID.
          2. +

          + +

          +
        2. Send an email describing the problems you had faced while signing up or logging in.
          3. +
        \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/repos.mdx b/src/docusaurus/versioned_docs/version-3.1/repos.mdx new file mode 100644 index 0000000..98d749f --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/repos.mdx @@ -0,0 +1,32 @@ +import PartialExample from './_mentored.mdx'; + +# Mentor Source Code Repositories +You can download the source code for the platform from the following repositories: + +## Mentor Service + +https://github.com/ELEVATE-Project/mentoring.git + +## Interface Service + +https://github.com/ELEVATE-Project/interface-service + +## Progressive Web App (PWA) + +https://github.com/ELEVATE-Project/mentoring-mobile-app.git + +## Supporting Services + +Optionally, you can download the source code for the following services: + +### User Service + +https://github.com/ELEVATE-Project/user.git + +### Notification Service + +https://github.com/ELEVATE-Project/notification.git + +### Scheduler Service + +https://github.com/ELEVATE-Project/scheduler.git \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/request-beamentor.mdx b/src/docusaurus/versioned_docs/version-3.1/request-beamentor.mdx new file mode 100644 index 0000000..552b8c6 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/request-beamentor.mdx @@ -0,0 +1,30 @@ +import Admonition from '@theme/Admonition'; + +# Requesting to Become a Mentor + +To become a mentor and host sessions, you can send a request to the organization administrator. + + +

        You can send a request to become a mentor only after updating your profile.

        +         + +**To send a request to become a mentor, do as follows:** + +1. Do one of the following actions: + + * On the Home page, click **Become a Mentor**. + * Go to **Profile** and click **Become a Mentor**. + + +

        To learn more about viewing your profile, see Creating a Mentee Profile.

        +         + +2. On the Become a Mentor page, verify your profile details and edit the information if required. + + ![](media/becomeamentor-page.png) + +3. Click **Request to be a Mentor**. + + +

        You will receive an email notification after the organization administrator reviews and approves the request.

        +         \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/setting-up-a-session.mdx b/src/docusaurus/versioned_docs/version-3.1/setting-up-a-session.mdx new file mode 100644 index 0000000..e43c6a0 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/setting-up-a-session.mdx @@ -0,0 +1,318 @@ +import PartialExample from './_mentored.mdx'; +import FormFieldsNote from './_formfieldscustomizability.mdx'; +import Admonition from '@theme/Admonition'; + +# Setting up a Session + +To share your skills and knowledge with your mentees, you can create a session and add requisite details such as: + +* The topic for the session +* The session schedule +* A creative graphic or image to attract the attention of mentees +* The meeting platform + +**To create a session, do as follows:** + +1. On the Home page, go to My mentoring sessions tab. + +2. Click Create session. The Create a new session page appears. + + ![](media/portal-createsession.png) + +3. Optionally, to add a session image, click Add image and do one of the following actions: + + * To take a picture, select Take Photo. + * To upload an image, select Choose from library. +

        + +

        Select an image that is relevant to the session topic.

        + +

        + +4. Enter the session information in the Session title box and Description box. + + + +5.
        + If you are a mentor with Session Manager privileges, click here for the following actions: + + 1. To select the type of session, do as follows: + + 1. Click the Session type box. + 2. Select the session type from the Session type dropdown and click Ok. + +

        + +

        You cannot change the session type after publishing the session.

        + +

        + + 2. To add your name in the Add mentor box, do as follows: + + 1. Click + Add mentor. The Mentor list window appears. + 2. Find your name from the list and click Add. + + ![](media/mentorlistwindow.png) + +

        + +

        From the Mentor or Mentee list window, you can find users by:

        +
          +
        • Searching for the user in the Search box.
          • +
        • Using filters such as the user's organization or designation.
          • +
        • Changing the number of users listed on the page using the Items per page dropdown.
          • +
        + +

        + + 3. To invite mentees, do as follows: + + 1. Click + Add mentee. The Mentee list window appears. + 2. Find a mentee from the list and click Add. + + ![](media/mentorlistwindow.png) + +

        + +

        It is optional to invite mentees to a Public session.

        + +

        + +

        + +

        You cannot add mentees after the session enrollment limit is reached. If you add new mentees after this limit is reached, a session seats full message appears.

        + +

        +
        + +6. To schedule a session, do as follows: + + 1. Click the Start date box and End date box. + 2. Select the date and time from the date and time picker. + 3. Click ![](media/selectdateandtime.png). + +

        + +

        The session duration should be at least 30 minutes.

        + +

        + +7. Select an option from the following: + + * Recommended for + * Categories + * Medium + + ![](media/recommendedcategorymedium.png) + +8. Click **+Select Recommended for**. The **Select Recommended for** window appears. + + ![](media/recommendedfor.png) + +9. Select the checkbox for the options that you want to recommend. You can also do a quick search using the search bar. Type one or + more letters in the search bar. The items are displayed based on the search term you typed. + +10. Do one of the following actions: + * Click **Save** to save the selected Recommended options. + * Click **Clear all** to clear the selected options. + * Click **X** to close the window without saving the changes. + +11. After you click **Save**, the selected items appears under the **+Select Recommended for** section. + + ![](media/selectedrecommends.png) + +12. To add a new item, click **+Other**. This opens a popup window. + + ![](media/other.png) + +13. Enter the recommended item that you would like to add and then click **Ok**. + The newly added item appears as **+1more** as shown in the following figure. + + ![](media/otheroptionadded.png) + + +

        + + A maximum of five options will be shown. + If there are more than five options, they will be denoted with “+number of additional options." + For example, if 11 options are selected, the first five will appear under the + Select Recommended for section, + while the remaining six will be shown as "+6more". + +

        + +14. Repeat the same procedure as **+Select Recommended for**, to select the categories and the medium for creating a session. + + ![](media/categoryandmedium.png) + + +15. Click Publish and add link. The session is published on the platform and mentees can now view your session. + +

        + +

        You must set the meeting platform on the Meeting Link tab.

        + +

        + + ![](media/portal-addmeetinglink.png) + +

        + +

        To go back and edit the session details, do as follows:

        +
          +
        1. Go to the Edit session tab.
          2. +
        2. Make the necessary changes and click Save.
          3. +
        + +

        + +16. On the Meeting link tab, select a meeting platform from the Add meeting link menu. + +

        + +

        If you haven't selected a meeting platform, BigBlueButton is set as the default platform.

        + +

        + + + + + + + + + + + + + + + + + + + + + + +
        Meeting PlatformMeeting Information
        BigBlueButtonNo action required.
        Google MeetCopy and paste the call link in the Meet link box.
        WhatsAppCopy and paste the call link in the WhatsApp box.
        Zoom

        Do the following actions:

        1. Copy and paste the meeting link in the Zoom link box.
        2. Copy and paste the meeting ID in the Meeting ID box.
        3. Copy and paste the passcode in the Passcode box.
        + +17. Click Submit. The meeting information is added. + +

        + +

        You can find the new session on My mentoring sessions tab on the Home page.

        +

        On My mentoring sessions tab, you can view your upcoming and completed sessions.

        + +

        + +## Tracking the Number of Enrollments + +You can view the number of mentees who have enrolled or those who were invited to the session. + +1. On My mentoring sessions tab, click the session tile. + + ![](media/portal-newsession.png) + +2. View the **Mentee count** value. + + ![](media/portal-editsession.png) + +## Viewing the List of Mentees + +On the Mentee list window, you can do the following actions: + +* View mentees' details. +* Check whether the mentees have enrolled for the session or have been invited to the session. + +**To view the list of mentees, do as follows:** + +1. On My mentoring sessions tab, click the session tile. + + ![](media/portal-newsession.png) + +2. On the Session Details page, click **View list**. The Mentee list window appears. + +

        + +

        Click the Download link to download the mentee list as a CSV file.

        + +

        + + ![](media/menteeenrollmentlist.png) + +## Updating a Session + +1. On My mentoring sessions tab, click the session tile. + + ![](media/portal-newsession.png) + +2. On the Session Details page, click Edit. The Edit session details page appears. + + ![](media/portal-editsession.png) + +### Updating the Session Details + +

        + +

        You can edit the session details only until the start of the session.

        + +

        + +1. On the Edit session details page, go to the Edit session tab. + +2. Make the necessary changes to: + + * The session information. + *
        + The list of mentees who were invited to the session. If you are a mentor with Session Manager privileges, you can update the list using any one of the following actions: +
          +
        • To invite new mentees, click + Add New Mentee and add mentees from the list.
          • +
        • To remove mentees from the list, click the mentee's name and click Remove on the Mentee list window.
          • +
        +
        + * The session image. To update the session image, click Add image and do one of the following actions: + + * To take a picture, select Take Photo. + * To upload an image, select Choose from library. + * To remove the existing image, select Remove current photo. + +

        + +

        Select an image that is relevant to the session topic.

        + +

        + +3. Click Save. The session details are updated. + +### Updating the Meeting Information + +

        + +

        After starting the session, you can go back to and edit the meeting information. The session that you have started appears as Live on the My mentoring sessions tab.

        + +

        + +1. On the Edit Session Details page, go to the Meeting link tab and make the necessary changes. + +2. Click Submit. The meeting information is updated. + +## Deleting a Session + + +

        You can delete the session only until the start of the session.

        +         + +**To delete the session, do as follows:** + +1. On My mentoring sessions tab, click the session tile. + + ![](media/portal-newsession.png) + +2. Click the session tile and click Delete. + + ![](media/portal-editsession.png) + +3. Click Yes delete on the confirmation dialog. The session is cancelled and is removed from the My mentoring sessions tab of the Home page. + + + diff --git a/src/docusaurus/versioned_docs/version-3.1/settingup-overview.mdx b/src/docusaurus/versioned_docs/version-3.1/settingup-overview.mdx new file mode 100644 index 0000000..8bb6965 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/settingup-overview.mdx @@ -0,0 +1,40 @@ +import PartialExample from './_mentored.mdx'; +import PartialExample2 from './_elevate.mdx'; +import Shiksha from './_shiksha.mdx'; +import Admonition from '@theme/Admonition'; + +# Hosting and Customizing Mentor + +The capability is enabled by the microservice which can be set up in any cloud environment or in an on-premise setup. + +In addition, system administrators can also set up a reference implementation (Progressive Web App or PWA) and customize the look and feel based on the needs. See [Customize the PWA](https://github.com/ELEVATE-Project/mentoring-mobile-app/blob/master/README.md) to learn more. + +Other services such as User, Notification, Scheduler, and BigBlueButton are optional. The service can work with one or more existing implementations of the same. + +To host a customized instance of : + +1. [Set up PostgreSQL](https://github.com/ELEVATE-Project/mentoring/blob/master/README.md). +2. [Install Node.js® on Ubuntu 20.04](https://serverspace.io) (Search for *Install Node.js on Ubuntu 20.04* in the Tutorials section.). +3. [Set up service](https://github.com/ELEVATE-Project/mentoring/blob/master/README.md). +4. [Set up Interface service](https://github.com/ELEVATE-Project/interface-service/blob/main/README.md). +5. [Customize the PWA](https://github.com/ELEVATE-Project/mentoring-mobile-app/blob/master/README.md). + +Optionally, to set up supporting services do as follows: + +* [Install Apache Kafka® on Ubuntu 20.04](https://www.digitalocean.com/community) (Search for *Install Apache Kafka on Ubuntu 20.04* in the **Community** search box.). +* Set up User Service. +* Set up Notification Service. +* Set up Scheduler Service. +* [Set up BigBlueButton Service](https://github.com/ELEVATE-Project/mentoring/blob/master/README.md). + +## Additional Resources + +|To learn more| See the following links| +|--------------|-----------| +|API Documentation|https://dev.elevate-apis.shikshalokam.org/mentoring/api-doc| +| Service|https://github.com/ELEVATE-Project/mentoring.git| +|Interface Service|https://github.com/ELEVATE-Project/interface-service| +|Supporting Service: User Service|https://github.com/ELEVATE-Project/user.git| +|Supporting Service: Notification Service|https://github.com/ELEVATE-Project/notification.git| +|Supporting Service: Scheduler Service|https://github.com/ELEVATE-Project/scheduler.git| + diff --git a/src/docusaurus/versioned_docs/version-3.1/signing-up-as-a-mentee.mdx b/src/docusaurus/versioned_docs/version-3.1/signing-up-as-a-mentee.mdx new file mode 100644 index 0000000..7183db8 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/signing-up-as-a-mentee.mdx @@ -0,0 +1,28 @@ +import PartialExample from './_mentored.mdx'; +import SignUp from './_signup.mdx'; +import BurgerMenu from './media/burgermenu-icon.png' +import PortalApplicationMenu from './media/portal-menteeapplicationmenu.png' +import Admonition from '@theme/Admonition'; + +# Signing up as a Mentee + +You can create an account as a mentee if you received: + +* The application's link from your organization. +* Shared session or mentor profile links from your contacts. + +**To sign up as a mentee, do as follows:** + + + +## Logging out + +To log out, do one of the following actions: + +* Select Logout from the Application menu. + +* Go to the Application menu and select Logout. + +

        + +

        diff --git a/src/docusaurus/versioned_docs/version-3.1/signing-up-as-a-mentor.mdx b/src/docusaurus/versioned_docs/version-3.1/signing-up-as-a-mentor.mdx new file mode 100644 index 0000000..c99426e --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/signing-up-as-a-mentor.mdx @@ -0,0 +1,25 @@ +import PartialExample from './_mentored.mdx'; +import SignUp from './_signup.mdx'; +import BurgerMenu from './media/burgermenu-icon.png' +import PortalApplicationMenu from './media/portal-mentorapplicationmenu.png' +import Admonition from '@theme/Admonition'; + +# Signing up as a Mentor + +After receiving the application's link from your organization through an email invite, you must sign up to create your account. + +**To sign up as a mentor, do as follows:** + + + +## Logging out + +To log out, do one of the following actions: + +* Select Logout from the Application menu. + +* Go to the Application menu and select Logout. + +

        + +

        \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/starting-a-session.mdx b/src/docusaurus/versioned_docs/version-3.1/starting-a-session.mdx new file mode 100644 index 0000000..5c2f987 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/starting-a-session.mdx @@ -0,0 +1,114 @@ +import PortalStartButton from './media/portal-startbutton.png' +import AssignedStartButton from './media/assignedsessiontile.png' +import PortalNewSession from './media/portal-newsession.png' +import PortalStartSessionButton from './media/portal-sessiondetailsstart.png' +import AssignedStartSessionButton from './media/assignedsessiondetailsstart.png' +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import Admonition from '@theme/Admonition'; +import PartialExample from './_mentored.mdx'; + +# Starting a Session + +You can find Public or Private sessions that you have created or were assigned by a session manager by accessing the **My Mentoring Sessions** tab on the Home page. You can host these sessions through a configured meeting platform. + +

        + +

        To look for sessions that were assigned to you by a session manager, check the session tile that is labelled as assigned.

        + +

        + + +
          +
        • You can start the session only 10 minutes before the scheduled time.
          • +
        • You can start the session anytime within the time allocated for the session.
          • +
        +         + +You can start a session in one of the following ways: + +* Using the **Start** button +* Using the Session Details page +* Using the shared link to start a Public session + +## Using the Start Button + +
          +
        1. On your Home page, go the My mentoring sessions tab.
          2. +
        2. Find the session.
          3. +
        3. Click Start. The meeting window appears.
          4. +

          + +

          If an error occurs, go back to and click Start.

          + +

          +

          + + +

          + +

          + + +

          + +

          +           + +

          +
        + +## Using the Session Details Page + +
          +
        1. On your Home page, go the My mentoring sessions tab.
          2. +
        2. Click the session tile to view the Session Details page.
          3. +

          + +

          +
        3. Click Start session. The meeting window appears.
          4. + + +

          + +

          +           + +

          + +

          +           +           +
        + +## Using the Shared Link to Start a Public Session + +
          +
        1. Click the session link which was shared with your contacts or on social media. The Session Details page appears.
          2. +

          + +

          +
        2. Click Start session. The meeting window appears.
          3. +
        + +

        + +

        To configure the meeting settings, see any one of the following sections:

        + + +

        + +## Usage Guidelines + +- Unmute your microphone only when necessary. + +- Maintain a neat background and attire before you turn on your webcam. + +- Use respectful language while sharing any information. + +- If you leave a BigBlueButton meeting unintentionally (by pressing the back key on your phone or closing the meeting tab), go back to and click Start. diff --git a/src/docusaurus/versioned_docs/version-3.1/technicalarchitecture.mdx b/src/docusaurus/versioned_docs/version-3.1/technicalarchitecture.mdx new file mode 100644 index 0000000..3ee1c22 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/technicalarchitecture.mdx @@ -0,0 +1,6 @@ +# Mentor Architecture + + + + +![technical architecture diagram](media/architecture.png) \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/typesofsessions.mdx b/src/docusaurus/versioned_docs/version-3.1/typesofsessions.mdx new file mode 100644 index 0000000..475fad6 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/typesofsessions.mdx @@ -0,0 +1,31 @@ +# Types of Sessions on Mentor + +Users with Session Manager privileges can create, host or assign Public and Private sessions. + + + + + + + + + + + + + + +
        Types of SessionsDescription
        Public +
          +
        • Mentees can discover and enroll for the sessions.
          • +
        • Optionally, apart from the enrolled mentees, session managers can also invite mentees to the session.
          • +
        • Mentors and mentees can share the session links to with their contacts or on social media.
          • +
        +
        Private +
          +
        • Only invited mentees can join a Private session.
          • +
        • To facilitate one-on-one mentoring, session managers can set up Private sessions consisting of a mentor and an invited mentee.
          • +
        +
        + + diff --git a/src/docusaurus/versioned_docs/version-3.1/using-faq.mdx b/src/docusaurus/versioned_docs/version-3.1/using-faq.mdx new file mode 100644 index 0000000..87f104f --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/using-faq.mdx @@ -0,0 +1,13 @@ +# Using the FAQ Page + +You can find answers to commonly asked questions about the application. + +**To view the FAQ page, do as follows:** + +1. Do one of the following actions: + * Select **FAQ** from the **Application** menu. + * Go to the **Application** menu ![burger menu](media/burgermenu-icon.png) and select **FAQ**. + +2. On the FAQ page, click the dropdown icon located next to question to view the answer. + + ![](media/portal-faq.png) diff --git a/src/docusaurus/versioned_docs/version-3.1/using-the-application.mdx b/src/docusaurus/versioned_docs/version-3.1/using-the-application.mdx new file mode 100644 index 0000000..2851ba1 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/using-the-application.mdx @@ -0,0 +1,33 @@ +import PartialExample from './_mentored.mdx'; +import portalWelcome from './media/portal-welcome.png'; +import Admonition from '@theme/Admonition'; + +# About the Mentor Application + +The reference solution () uses all the microservices available in this building block, like , Notifications, Scheduler, and User Management. It scaffolds the following processes: + +1. Build an open network of mentors, who can host mentoring interactions. +2. Make them searchable (discoverable) by registered mentees or mentors. +3. Discover mentors and establish contact with them. +4. Communicate to plan the implementation of the mentoring sessions. +5. Capture feedback to evaluate the quality of interaction. + +The building block and the associated microservices provide virtual mentorship capabilities. One of the most important things to recognize about **mentoring as an approach to learning** is that it is incredibly diverse and can have a formal or informal setup. + +The capability can be deployed as a standalone solution or integrated with a learning and development program. Its salient features are as follows: + +* Intuitive web interface for all users +* Role-based workflow for mentor, mentee, organization administrator, and session manager +* Mentoring session broadcast and session discovery +* Group (one to many) and one-on-one sessions +* Virtual meeting platforms such as BigBlueButton™ (default) and others +* Communication using email notifications +* Reports for mentors and mentees +* Security features that include password management and tracking devices through which you have logged in to the application. + +

        + +

        Help videos are available for quick reference of the implementation.

        +

        To learn more about the building block, see Welcome to .

        + +

        \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/view-helpvideos.mdx b/src/docusaurus/versioned_docs/version-3.1/view-helpvideos.mdx new file mode 100644 index 0000000..794db42 --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/view-helpvideos.mdx @@ -0,0 +1,13 @@ +# Viewing the Help Videos + +You can find video instructions about using the application features. + +**To view the video instructions, do as follows:** + +1. Do one of the following actions: + * Select **Help videos** from the **Application** menu. + * Go to the **Application** menu ![burger menu](media/burgermenu-icon.png) and select **Help videos**. + +2. Click the appropriate tile to play the video instructions. + + ![](media/portal-helpvideos.png) \ No newline at end of file diff --git a/src/docusaurus/versioned_docs/version-3.1/viewmentorprofilelink.mdx b/src/docusaurus/versioned_docs/version-3.1/viewmentorprofilelink.mdx new file mode 100644 index 0000000..7688bda --- /dev/null +++ b/src/docusaurus/versioned_docs/version-3.1/viewmentorprofilelink.mdx @@ -0,0 +1,39 @@ +import PortalMentorProfilePage from './media/portal-mentorprofilepage.png'; +import Admonition from '@theme/Admonition'; +import PartialExample from './_mentored.mdx'; + +# Using a Shared Link to View a Mentor Profile + +You can view a mentor profile using a link shared by your contacts or on social media. + +

        + +

        Users who have not registered on yet, should do the following actions:

        +
          +
        1. Click the shared link to open .
          2. +
        2. Sign up to create a new account.
          3. +
        3. Update your profile before enrolling and joining for sessions created by the mentor.
          4. +
        + +

        + +

        To view the mentor profile page, click the shared mentor profile link. The mentor profile page appears.

        + +

        + +

        Registered users may need to log in to their account.

        + +

        + +

        + +

        + + +

        To learn more about viewing the profile of other mentors, see Mentor Directory.

        +

        To learn more about enrolling and joining for sessions created by the mentor, see the following topics:

        + +         \ No newline at end of file diff --git a/src/docusaurus/versioned_sidebars/version-3.1-sidebars.json b/src/docusaurus/versioned_sidebars/version-3.1-sidebars.json new file mode 100644 index 0000000..ea24073 --- /dev/null +++ b/src/docusaurus/versioned_sidebars/version-3.1-sidebars.json @@ -0,0 +1,356 @@ +{ + "tutorialSidebar": [ + { + "type": "category", + "label": "Getting Started", + "items": [ + { + "type": "doc", + "id": "intro", + "label": "Introduction" + }, + { + "type": "doc", + "id": "technicalarchitecture", + "label": "Architecture" + }, + { + "type": "doc", + "id": "key-capabilities", + "label": "Key Capabilities" + } + ] + }, + { + "type": "doc", + "id": "settingup-overview", + "label": "Hosting and Customizing Your Instance" + }, + { + "type": "category", + "label": "Setting up Organizational Rules and Policies", + "items": [ + { + "type": "doc", + "id": "policyarchitecture", + "label": "About Organizational Rules and Policies" + }, + { + "type": "category", + "label": "API Reference", + "items": [ + { + "type": "doc", + "id": "api-overview", + "label": "Overview" + }, + { + "type": "doc", + "id": "api-setpolicies", + "label": "Set Policies for Organizations" + }, + { + "type": "doc", + "id": "api-setrules", + "label": "Set Rules for Mentor and Session Discovery" + }, + { + "type": "doc", + "id": "api-entitytypeandentity", + "label": "Create Entity Types and Entities" + } + ] + } + ] + }, + { + "type": "category", + "label": "Using the Application", + "items": [ + { + "type": "doc", + "id": "using-the-application", + "label": "About the Application" + }, + { + "type": "doc", + "id": "gettingstarted", + "label": "Getting Started with the Application" + }, + { + "type": "doc", + "id": "typesofsessions", + "label": "Types of Sessions" + }, + { + "type": "doc", + "id": "notifications", + "label": "Notifications" + }, + { + "type": "category", + "label": "Managing Users for an Organization", + "items": [ + { + "type": "doc", + "id": "aboutorganizationadministrator", + "label": "Organization Administrator" + }, + { + "type": "doc", + "id": "bulkupload", + "label": "Uploading Users to the Application" + }, + { + "type": "doc", + "id": "managementorrequests", + "label": "Managing Requests to Become a Mentor" + } + ] + }, + { + "type": "category", + "label": "Managing Sessions for an Organization", + "items": [ + { + "type": "doc", + "id": "aboutsessionmanager", + "label": "Session Manager" + }, + { + "type": "doc", + "id": "createsession-sessionmanager", + "label": "Creating Sessions for an Organization" + }, + { + "type": "doc", + "id": "manageassignedsession", + "label": "Managing Sessions Assigned to Mentors" + }, + { + "type": "doc", + "id": "joinassignedsession", + "label": "Joining Sessions Assigned to Mentors" + }, + { + "type": "doc", + "id": "dashboard-for-sm", + "label": "Dashboard" + } + ] + }, + { + "type": "category", + "label": "How Mentors Can Use the Application", + "items": [ + { + "type": "doc", + "id": "signing-up-as-a-mentor", + "label": "Signing up as a Mentor" + }, + { + "type": "doc", + "id": "logging-in-mentor", + "label": "Logging in" + }, + { + "type": "doc", + "id": "creating-and-managing-mentor-profile", + "label": "Creating a Profile" + }, + { + "type": "doc", + "id": "setting-up-a-session", + "label": "Setting up a Session" + }, + { + "type": "doc", + "id": "inviting-mentorsandmentees-host", + "label": "Promoting Your Public Sessions" + }, + { + "type": "doc", + "id": "starting-a-session", + "label": "Starting a Session" + }, + { + "type": "doc", + "id": "dashboard-for-mentors", + "label": "Dashboard" + }, + { + "type": "doc", + "id": "feedbackformentors", + "label": "Providing Feedback on a Session" + }, + { + "type": "doc", + "id": "mentor-deleteaccountrequest", + "label": "Deleting the Account" + } + ] + }, + { + "type": "category", + "label": "How Mentees Can Use the Application", + "items": [ + { + "type": "doc", + "id": "signing-up-as-a-mentee", + "label": "Signing up as a Mentee" + }, + { + "type": "doc", + "id": "logging-in-mentee", + "label": "Logging in" + }, + { + "type": "doc", + "id": "creating-and-managing-mentee-profile", + "label": "Creating a Profile" + }, + { + "type": "doc", + "id": "request-beamentor", + "label": "Requesting to Become a Mentor" + }, + { + "type": "doc", + "id": "mentor-directory", + "label": "Using the Mentor Directory" + }, + { + "type": "doc", + "id": "viewmentorprofilelink", + "label": "Using a Shared Link to View a Mentor Profile" + }, + { + "type": "doc", + "id": "enrolling-for-a-session", + "label": "Enrolling for a Session" + }, + { + "type": "doc", + "id": "inviting-mentorsandmentees-participants", + "label": "Promoting Public Sessions with Your Contacts" + }, + { + "type": "doc", + "id": "joining-a-session", + "label": "Joining a Session" + }, + { + "type": "doc", + "id": "joining-sessions-using-a-shared-link", + "label": "Using a Shared Link to Join a Session" + }, + { + "type": "doc", + "id": "dashboard-for-mentees", + "label": "Dashboard" + }, + { + "type": "doc", + "id": "feedbackformentees", + "label": "Providing Feedback on a Session" + }, + { + "type": "doc", + "id": "mentee-deleteaccountrequest", + "label": "Deleting the Account" + } + ] + }, + { + "type": "doc", + "id": "change-language", + "label": "Changing the Language Settings" + }, + { + "type": "category", + "label": "Support", + "items": [ + { + "type": "doc", + "id": "report-signuporloginissue", + "label": "Reporting Sign up and Log in Issues" + }, + { + "type": "doc", + "id": "report-an-issue", + "label": "Reporting an Issue" + }, + { + "type": "doc", + "id": "using-faq", + "label": "Using the FAQ Page" + }, + { + "type": "doc", + "id": "view-helpvideos", + "label": "Viewing the Help Videos" + } + ] + }, + { + "type": "category", + "label": "Account Security", + "items": [ + { + "type": "doc", + "id": "accountloginactivity", + "label": "Viewing the Account Login Activity" + }, + { + "type": "doc", + "id": "changepassword", + "label": "Changing the Account Password" + } + ] + }, + { + "type": "doc", + "id": "faq", + "label": "FAQs" + }, + { + "type": "category", + "label": "Troubleshooting", + "items": [ + { + "type": "doc", + "id": "bulkupload-invalidsession", + "label": "Invalid Sessions During Bulk Upload" + } + ] + } + ] + }, + { + "type": "category", + "label": "Additional Technical Resources", + "items": [ + { + "type": "doc", + "id": "apidocumentation", + "label": "API Documentation" + }, + { + "type": "doc", + "id": "databasedesign", + "label": "Database Design" + }, + { + "type": "doc", + "id": "repos", + "label": "Source Code Repositories" + } + ] + }, + { + "type": "doc", + "id": "discussions", + "label": "Discussions" + } + ] +} diff --git a/src/docusaurus/versions.json b/src/docusaurus/versions.json index ea8b8cb..4dc7c3e 100644 --- a/src/docusaurus/versions.json +++ b/src/docusaurus/versions.json @@ -1,4 +1,5 @@ [ + "3.1", "3.0", "2.6", "2.5"