Merge pull request #810 from marwa-benhassine/update-documentation-or…

…iginmarwa
riadvice · Aug 31, 2023 · 2017d9e · 2017d9e
2 parents ec9606f + f0de51d
commit 2017d9e
Show file tree

Hide file tree

Showing 84 changed files with 1,756 additions and 939 deletions.
diff --git a/bbbeasy-docs/build-docs.sh b/bbbeasy-docs/build-docs.sh
@@ -1,3 +1,4 @@
 #!/bin/bash
 
+yarn install
 yarn build
diff --git a/bbbeasy-docs/docusaurus.config.js b/bbbeasy-docs/docusaurus.config.js
@@ -44,7 +44,7 @@ const config = {
           // Please change this to your repo.
           // Remove this to remove the "edit this page" links.
           editUrl:
-            'https://github.com/riadvice/bbbeasy/tree/develop/bbbeasy-docs',
+              'https://github.com/riadvice/bbbeasy/tree/develop/bbbeasy-docs',
         },
         theme: {
           customCss: require.resolve('./src/css/bbbeasy.css'),
@@ -54,111 +54,111 @@ const config = {
   ],
 
   themeConfig:
-    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
-    ({
-      // Replace with your project's social card
-      image: 'img/docusaurus-social-card.jpg',
-      navbar: {
-        title: 'BBBEasy',
-        logo: {
-          alt: 'BBBEasy Logo',
-          src: 'img/logo.svg',
-        },
-        items: [
-          {
-            type: 'doc',
-            docId: 'user-guide/congratulations',
-            position: 'left',
-            sidebarId: 'user',
-            label: 'User Guide',
-          },
-          {
-            type: 'doc',
-            docId: 'administrator-guide/software',
-            sidebarId: 'administrator',
-            position: 'left',
-            label: 'Administrator Guide',
-          },
-          {
-            type: 'doc',
-            docId: 'developer-guide/bbbeasy-configuration-utility',
-            sidebarId: 'developer',
-            position: 'left',
-            label: 'Developer Guide',
-          },
-          {
-            type: 'doc',
-            docId: 'api-reference/overview',
-            position: 'left',
-            sidebarId: 'api',
-            label: 'API',
-          },
-          {
-            label: 'Discussions',
-            href: 'https://github.com/riadvice/bbbeasy/discussions',
-            position: 'right',
-          },
-          {
-            href: 'https://github.com/facebook/docusaurus',
-            label: 'GitHub',
-            position: 'right',
-          },
-        ],
-      },
-      footer: {
-        style: 'dark',
-        links: [
-          {
-            title: 'Docs',
-            items: [
-              {
-                label: 'User Guide',
-                to: '/user-guide/introduction/welcome',
-              },
-              {
-                label: 'Administrator Guide',
-                to: '/administrator-guide/software',
-              },
-              {
-                label: 'Developer Guide',
-                to: '/developer-guide/bbbeasy-configuration-utility',
-              },
-              {
-                label: 'API',
-                to: '/api-reference/overview',
-              },
-            ],
-          },
-          {
-            title: 'Community',
-            items: [
-              {
-                label: 'Discussions',
-                href: 'https://github.com/riadvice/bbbeasy/discussions',
-              },
-              {
-                label: 'GitHub',
-                href: 'https://github.com/riadvice/bbbeasy',
-              },
-            ],
-          },
-          {
-            title: 'Commercial Support',
-            items: [
-              {
-                label: 'RIADVICE',
-                href: 'https://riadvice.tn/',
-              },
-            ],
+  /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
+      ({
+        // Replace with your project's social card
+        image: 'img/docusaurus-social-card.jpg',
+        navbar: {
+          title: 'BBBEasy',
+          logo: {
+            alt: 'BBBEasy Logo',
+            src: 'img/logo.svg',
           },
-        ],
-        copyright: `Copyright © 2022-${new Date().getFullYear()} BBBEasy, RIADVICE SUARL. Built with Docusaurus.`,
-      },
-      prism: {
-        theme: lightCodeTheme,
-        darkTheme: darkCodeTheme,
-      },
-    }),
+          items: [
+            {
+              type: 'doc',
+              docId: 'user-guide/introduction-welcome',
+              position: 'left',
+              sidebarId: 'user',
+              label: 'User Guide',
+            },
+            {
+              type: 'doc',
+              docId: 'administrator-guide/software',
+              sidebarId: 'administrator',
+              position: 'left',
+              label: 'Administrator Guide',
+            },
+            {
+              type: 'doc',
+              docId: 'developer-guide/bbbeasy-configuration-utility',
+              sidebarId: 'developer',
+              position: 'left',
+              label: 'Developer Guide',
+            },
+            {
+              type: 'doc',
+              docId: 'api-reference/overview',
+              position: 'left',
+              sidebarId: 'api',
+              label: 'API',
+            },
+            {
+              label: 'Discussions',
+              href: 'https://github.com/riadvice/bbbeasy/discussions',
+              position: 'right',
+            },
+            {
+              href: 'https://github.com/facebook/docusaurus',
+              label: 'GitHub',
+              position: 'right',
+            },
+          ],
+        },
+        footer: {
+          style: "dark",
+          links: [
+            {
+              title: "Docs",
+              items: [
+                {
+                  label: "User Guide",
+                  to: "/guides/user-guide/welcome",
+                },
+                {
+                  label: "Administrator Guide",
+                  to: "/guides/administrator-guide/software",
+                },
+                {
+                  label: "Developer Guide",
+                  to: "/guides/developer-guide/bbbeasy-configuration-utility",
+                },
+                {
+                  label: "API",
+                  to: "/guides/api-reference/overview",
+                },
+              ],
+            },
+            {
+              title: "Community",
+              items: [
+                {
+                  label: "Discussions",
+                  href: "https://github.com/riadvice/bbbeasy/discussions",
+                },
+                {
+                  label: "GitHub",
+                  href: "https://github.com/riadvice/bbbeasy",
+                },
+              ],
+            },
+            {
+              title: "Commercial Support",
+              items: [
+                {
+                  label: "RIADVICE",
+                  href: "https://riadvice.tn/",
+                },
+              ],
+            },
+          ],
+          copyright: `Copyright © 2022-${new Date().getFullYear()} BBBEasy, RIADVICE SUARL. Built with Docusaurus.`,
+        },
+        prism: {
+          theme: lightCodeTheme,
+          darkTheme: darkCodeTheme,
+        },
+      }),
 };
 
-module.exports = config;
+module.exports = config;
diff --git a/bbbeasy-docs/guides/administrator-guide/install.md b/bbbeasy-docs/guides/administrator-guide/install.md
@@ -28,11 +28,102 @@ usermod -s /bin/bash -c "Your Name <youremail@thecompany.kom>" root
 
 ## Install
 
-It is important to understand that BBBEasy installation have 2 stesp:
+It is important to understand that BBBEasy installation have 2 steps:
 
 1. Install in the server: install of the packages by the system administrator.
 2. Install from the web browser: configuration settings meant for creating the administrator account, branding and configuration of the presets.
 
+# Install steps
+
+`Tip` : If this is your first time using BBBeasy , it's primordially that you create an administrator account first in order to be able to use the application .
+
+The BBBeasy project work great in the browser .
+
+## Administrator account
+The administrator account consists of three steps :
+
+__The first step__
+
+* Create an administrator Account
+
+__The second step__
+
+* Fill the organization and branding fields
+
+__The third step__
+
+* Configure the BigBlueButton settings
+
+## Step 1 :  Administrator Account
+To create an administrator account , Please follow these steps
+
+>1. Enter the Username(The username is used only once )
+>2. Enter your Email(Your email must be personal and unique)
+>3. Create Password (Type a GDPR compatible password during installation)
+>4. Click on the Next button
+
+![Admin](/admin/admin.png)
+
+## Step 2: Organization and branding
+
+**Organization and branding are the best things for creating , design, and general look-and-feel of a company's branding**
+
+`To identify the Organisation  , fill in these fields `
+
+1. Organisation name
+2. Organisation website
+3. Platform name
+4. Terms of use URL
+5. Privacy Policy URL
+
+**Branding is very distinctive in that it defines  logo,Brand color,Default font size,Border radius and Wireframe style  to create organization and branding these fields must be filled out**
+1. Upload  the logo in the field designated for the logo
+2. Brand color
+3. Default font size (increase or decrease the default font size)
+4. Border radius
+5. Wireframe style
+6. Click on the Next button
+   ![Organisation & Branding](/branding/organisation_branding_step2.png)
+
+
+## Step3 BigBlueButton settings :
+
+BigBlueButton settings is the console to enable or disable the settings .
+Some of the key features of BBBeasy include :
+* Audio,
+* Branding
+* Breakout Rooms
+* General
+* Guest policy
+* Language
+* Layout
+* Learning Dashboard
+* Lock Settings
+* Recording
+* Screenshare
+* Security (Password for moderator & Password for attendee)
+* Presentations with interactive and multi-share whiteboard capabilities – such as a pointer, zooming and drawing,
+  public and private chat,
+* Breakout rooms,
+* User Experience
+* Webcams
+* ZcaleRight
+
+  **An overview of some BigBlueButton settings**  :
+
+1. Duration: set the duration of the meeting
+2. Maximum participants: Maximum numbers of users that can join the room
+3. Anyone can start the meeting: Anyone can start the room even he's not the room's owner
+4. Join all as moderators: All the users join the meeting as Moderators
+5. Allow only logged users: Only the logged in  users will be able to join the room
+>You can easily join a BigBlueButton meeting  by opening the room link and click on the join button via a browser on your laptop or mobile phone.
+## Finish
+After enable/ disable the BigBlueButton settings  , Click on the ` Finish` button .
+
+The application  will  be installed and you will be able to use the application
+
+![Bigbluebutton room setting](/bbbsettings/bigbluebutton_setting.png)
+![Install](/bbbsettings/finish.png)
 ### Server install
 
 Installing BBBEasy happens through a single command line.
@@ -46,6 +137,6 @@ wget -qO- https://raw.githubusercontent.com/riadvice/bbbeasy/develop/install.sh
 The available options are:
 - `-h hostname`: By default if not provided it will get the value from `hostname` command line.
 - `-t docker|git`: By default the `docker` install will have precedence. If `git` is chosen it will install all the dependencies required to run the platfrom.
-- `-d directory` : The directory to use for installing BBBEasy. By default, it is `hivevlet` under teh current work directory.
+- `-d directory` : The directory to use for installing BBBEasy. By default, it is `BBBeasy` under the current work directory.
 
 ## Switching the web-application after the installation process