glific · mahajantejas · May 24, 2024 · Sep 15, 2023 · Sep 19, 2023 · Sep 21, 2023
diff --git a/.env.example b/.env.example
@@ -1,3 +1,4 @@
 ALGOLIA_APP_ID=
 ALGOLIA_API_KEY=
 ALGOLIA_INDEX_NAME=
+BASE_URL="docs"
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -25,6 +25,7 @@ jobs:
           ALGOLIA_APP_ID: ${{ secrets.ALGOLIA_APP_ID }}
           ALGOLIA_API_KEY: ${{ secrets.ALGOLIA_API_KEY }}
           ALGOLIA_INDEX_NAME: ${{ secrets.ALGOLIA_INDEX_NAME }}
+          BASE_URL: ${{ secrets.BASE_URL }}
         run: yarn build
 
       # Popular action to deploy to GitHub Pages:

diff --git a/.github/workflows/netlify.yml b/.github/workflows/netlify.yml
@@ -0,0 +1,35 @@
+name: Build and Deploy to Netlify
+on:
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Build website
+        env:
+          ALGOLIA_APP_ID: ${{ secrets.ALGOLIA_APP_ID }}
+          ALGOLIA_API_KEY: ${{ secrets.ALGOLIA_API_KEY }}
+          ALGOLIA_INDEX_NAME: ${{ secrets.ALGOLIA_INDEX_NAME }}
+          BASE_URL: ""
+        run: yarn build
+
+      - name: Deploy to Netlify
+        uses: nwtgck/[email protected]
+        with:
+          publish-dir: './build'
+          production-branch: master
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          deploy-message: 'Deploy from GitHub Actions'
+          enable-pull-request-comment: true
+          overwrites-pull-request-comment: true
+          alias: deploy-preview-${{ github.event.number }}
+        env:
+          NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
+          NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
+        timeout-minutes: 1
diff --git a/docs/2. Onboarding/01. Glific Onboarding Toolkit.md b/docs/2. Onboarding/01. Glific Onboarding Toolkit.md
@@ -55,7 +55,7 @@ ___
 ```
 https://staging.tides.coloredcow.com/
 Phone number: +917834811114
-Password: secret1234
+Password: Secret1234!
 ```
 
 Please don&#39;t use this to build extensive flows and testing on live numbers. We update the account every week so any work you do is likely to be removed. Please only use it to view the platform and check out the features.

diff --git a/docs/2. Onboarding/03. Setup an organisation on GupShup.md b/docs/2. Onboarding/03. Setup an organisation on GupShup.md
@@ -131,11 +131,13 @@ a) Disable Automated opt-in message.
 
 23. After verification, you will be live on Gupshup.
 
-24. To set up Glific, you’ll need to send us the following details at [https://cc.tides.coloredcow.com/organization-registration](https://cc.tides.coloredcow.com/organization-registration)
+24. To set up Glific, you’ll need to send us the following details at https://prod.glific.com/organization-registration
 
 25. App Name
 26. GupShup account phone number
-27. API key
+27. API key - Go to Gupshup, Click on the right corner top click on it and copy the API key and paste it in the Glific form
+
+<img width="213" alt="Screenshot 2024-02-15 at 9 29 44 AM" src="https://github.com/glific/docs/assets/143380171/71d4c140-ed0a-48c2-9167-815196e394c5"/>
 
 Click on `continue` button.
 

diff --git a/docs/2. Onboarding/GCS Setup/04. Upload files on GCS.md b/docs/2. Onboarding/GCS Setup/04. Upload files on GCS.md
@@ -1,4 +1,5 @@
-> ### **2 minute read &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; `Intermediate`**
+> ### **2 minute read &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; `Intermediate`**
+
 ___
 
 **To send files (images, audio, video, pdfs) to contacts, you would need to upload them to GCS and then attach link in the message.**
@@ -81,3 +82,5 @@ ___
 9.  Follow the steps to send the media files to contacts through a flow.
 
 - [Send media files in messages](https://glific.github.io/docs/docs/Product%20Features/Flows/Flow%20Actions/Send%20the%20contact%20a%20message/#send-media-files-in-a-message)
+
+
diff --git a/docs/3. Pilot Essentials.md b/docs/3. Pilot Essentials.md
@@ -0,0 +1,39 @@
+> ### **3 minute read &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; `Beginner`**
+
+Designing chatbots is an iterative process, and with every launch or pilot, you learn new things and make changes. But if you are launching your chatbot for the first time with your users, here are 15 quick things you need to check. It shouldn't take you more than 15 minutes to ensure everything is in order.
+
+Disable the automated opt-in message on Gupshup. This will prevent your users from receiving additional default messages from Gupshup, which might confuse them. To do this, click on your app on Gupshup, go to the Opt-ins tab, click on the Onboarding mechanisms dropdown arrow, and scroll down to disable the toggle.
+
+
+
+The first message that a user receives upon joining the bot should be a consent message. Here are a few guidelines for designing your consent message:
+Clearly mention the name of the organization and the purpose of the bot.
+Clearly ask the user if they would like to receive messages from the bot (You can provide an interactive message with a "Yes" or 👍🏼 button).
+Users should have an option to opt out. Therefore, add the keyword in the footer through which users can opt out from the bot.
+
+
+
+Other pointers to remember- 
+It is recommended to have the first message sent by the user to the chatbot, instead of you broadcasting the message to users, even if you have user details. Broadcasting messages might lead to user reporting or blocking the bot, which can affect the overall health of the bot. Unless you have obtained user consent outside the bot (on your app or manually), the first message should always be user-initiated.
+Create a separate flow for users who type "STOP" and add them to a collection for future reference.
+
+3) Update the Opt-in settings post-user consent. It is mandatory to update a contact's settings with Opt-in after their consent.
+
+
+4) Important user information collected during registration, such as Name, Language, Training group, City, etc., should be updated in the contact profile. This will be helpful for you to refer in any flow in future
+
+5) Confirm important information (like Name, Language, etc.) before updating the contact. Sometimes, users might enter incorrect information, which can impact the user experience throughout. 
+
+For example, sharing a name as "My name is Krishna Priya" instead of just "Krishna Priya" can lead to the bot referring to the user with the incorrect name every time. Additionally, a user choosing the wrong language preference by mistake might discourage them from using the bot.
+
+6) Set default and new contact flows through Settings → Flows to ensure that new users receive the intended flow.
+7) Add content in all nodes for all languages, if multiple languages are used for the bot.
+8) Add users to relevant collections based on how you want to communicate with them in the future.
+9) Use interactive messages wherever you want the user to choose from given options or when answers are predictable (e.g., grade, Yes/No, Gender, etc.).
+10) If a flow is triggered from your end to the user, the first message of the flow should be an HSM message (because we don't know if the users are in the active session window or not).
+11) Add labels for both outgoing and incoming messages for all the data you want to capture and check in the future.
+12) Use appropriate names for Flows, Keywords, and Result names to make it easy to track them in the future.
+13) Use emoticons, bold, italics, and media as needed.
+14) Ensure the user does not encounter any dead ends in the bot, especially in the case of interactive messages. Make sure there is also an option for the user to send free text apart from the button options you provide, and clarify what the user is expected to do. Connect the user's response back to the main question and wait for their response so the flow can proceed.
+
+15) Testing, Testing, Testing: Test the chatbot internally with at least 3 to 5 people on mobile phones before sharing it with actual users.
diff --git a/docs/3. Product Features/01. Chats.md b/docs/3. Product Features/01. Chats.md
@@ -1 +1,64 @@
-To be filled
+###**3 minute read &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; `Beginner`**
+
+
+**Chats**: This section on the left side is highlighted, indicating that the user is currently viewing the chat interface.
+
+<img width="1460" alt="Screenshot 2024-02-29 at 12 08 29 PM" src="https://github.com/glific/docs/assets/143380171/2c58a14c-307c-4179-8286-670e603692a4"/>
+
+**Chat Window**: The central part of the interface shows an ongoing conversation with a particular contact. 
+
+<img width="370" alt="Screenshot 2024-02-29 at 12 21 44 PM" src="https://github.com/glific/docs/assets/143380171/5535b55c-a1ea-42b9-b057-ce651d494966"/>
+
+**Contacts**: On the right side, there is a section titled 'Contacts' listing different contacts who have been interacted.
+The 1st highlighted part in the image enables you to search conversations by name, keyword, label, staff, collection name, and date range. This feature helps streamline your search process and refine results based on specific criteria.
+
+
+<img width="447" alt="image" src="https://github.com/glific/docs/assets/143380171/d576198f-c3ca-4755-a2bb-5a59c22dfc9d"/>
+<img width="433" alt="image" src="https://github.com/glific/docs/assets/143380171/1d061a58-dcff-4384-9d65-a63ee64c7b60"/>
+
+The second highlighted part in the image provides insights into the status of contacts, indicating the number who have opted in, opted out, and other relevant metrics. 
+
+All - Shows all contacts. 
+Not Replied - Shows contacts list whose messages were read but not replied to yet. 
+Not Responded - Shows contacts who have not responded yet to the messages.
+
+You can read more about this [here](https://glific.github.io/docs/docs/Product%20Features/Searches/#search-contacts)
+
+<img width="367" alt="image" src="https://github.com/glific/docs/assets/143380171/3953b10c-39c4-4a45-8c86-0c95c321aeca"/>
+
+**Collection**: Collections in Glific are like folders where you can gather a bunch of users together. Once you have them in a collection, you can send messages to everyone in that collection all at once. It is a handy way to keep things organized and communicate efficiently with different groups of users.You can find more details
+ [here](https://glific.github.io/docs/docs/Product%20Features/Others/Collections/)
+
+<img width="370" alt="Screenshot 2024-02-29 at 12 23 25 PM" src="https://github.com/glific/docs/assets/143380171/18b9f619-0eed-4d4e-b2ad-6d9b06859acd"/>
+
+**Saved Searches** : The saved searches are visible.
+
+<img width="363" alt="image" src="https://github.com/glific/docs/assets/143380171/9238400b-388e-4e21-97bc-455055af9740"/>
+
+
+
+
+**Session Timer** : You can also come to know the session timer for a particular contact in top right corner of the screen
+
+<img width="159" alt="Screenshot 2024-02-29 at 12 10 12 PM" src="https://github.com/glific/docs/assets/143380171/14649b61-1fd1-4680-8619-e621567b2d1b"/>
+
+
+**Shortcuts**:
+
+The handy shortcuts like Speed Send, Templates, and Interactive Messages are present in the bottom part of the chat screen. These shortcuts make messaging quicker and easier. 
+Speed Send helps you send messages faster, Templates let you use pre-made message formats, and Interactive Messages allow you to engage users more dynamically. They are like quick buttons that save you time and effort while communicating with users.
+
+
+<img width="882" alt="Screenshot 2024-02-29 at 12 11 21 PM" src="https://github.com/glific/docs/assets/143380171/c0c525f7-c903-4ad9-8813-f7bf4f0ca7f4"/>
+
+
+
+**Preview Button**:
+
+<img width="69" alt="Screenshot 2024-02-29 at 12 12 35 PM" src="https://github.com/glific/docs/assets/143380171/66403685-2984-4e90-a220-ca0c89f8d591"/>
+
+A green phone-like icon towards the right bottom end is present which acts as a preview button. When you click on it, you can see how your chats will actually look on a phone screen. It is like a sneak peek feature that lets you visualize how your messages will appear to users, helping you fine-tune your communication for a better user experience.
+
+
+<img width="281" alt="Screenshot 2024-02-29 at 12 13 21 PM" src="https://github.com/glific/docs/assets/143380171/0bbf03af-1c81-4af3-a834-b0719d7b7d93"/>
+
diff --git a/docs/3. Product Features/02. Speed Sends.md b/docs/3. Product Features/02. Speed Sends.md
@@ -1,12 +1,11 @@
-> ### **2 minutes read &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; `Beginner`**
+> ### **2 minutes read &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; `Beginner`**
 Speed Sends is a functionality in Glific to create a message or save the messages and reuse it in future chats.
 
 ## Create Speed Sends
 
-1. Create a Speed Sends message. Click on the `+CREATE SPEED SEND` button.
-
-<img width="1467" alt="SS SC1" src="https://github.com/glific/docs/assets/132430123/c1e4827b-9d6f-4858-a2c8-1238a9601203" />
+1. Create a Speed Sends message. Go to `Quick tools`, find `Speed Sends` click on `+Create`
 
+<img width="1445" alt="Screenshot 2024-02-29 at 1 22 27 PM" src="https://github.com/glific/docs/assets/141305477/bfa05e33-b5ab-4ebb-acf0-50f72a9ea7d9" />
 
 
 2.  Fill in the details of the Speed Sends message.
@@ -16,9 +15,8 @@ Speed Sends is a functionality in Glific to create a message or save the message
     1. Enter the exact message you want to send to users in the `Message` field.
     1. Select the type of attachment if you wish to attach any file with the message in `Attachment Type` field.
     1. Provide the URL of the message in the `Attachment URL` field.
-
-
-<img width="1263" alt="SS SC2" src="https://github.com/glific/docs/assets/132430123/8fb610db-ca88-457d-8a98-9ad6d49c290d" />
+
+<img width="552" alt="Screenshot 2024-03-04 at 2 29 04 PM" src="https://github.com/glific/docs/assets/141305477/daa77a08-91b7-4555-97bc-bfb89a067534" />
 
 
 
@@ -34,38 +32,35 @@ Speed Sends is a functionality in Glific to create a message or save the message
 
 
 
-6.  Click on `Speed Send`tab at the top of `Type a message` field.  A pop up will be shown with all the saved Speed Send messages.
+6.  Click on up arrow given in the left of `Type a message` field.  From the pop up select `Speed Sends`.
 
-<img width="1268" alt="SS SC3" src="https://github.com/glific/docs/assets/132430123/345e6089-9cf5-4035-a7be-91ac828d711e" />
+<img width="993" alt="Screenshot 2024-03-04 at 2 45 05 PM" src="https://github.com/glific/docs/assets/141305477/d2663fe5-1f98-4422-8484-9f785ae1ee80" />
 
 
 
 7. Click on the message you want to send.
-
-<img width="1267" alt="SSSC4" src="https://github.com/glific/docs/assets/132430123/0f4d0acd-695d-4e0f-9202-7ef693af0a03" />
+<img width="993" alt="Screenshot 2024-03-04 at 2 48 05 PM" src="https://github.com/glific/docs/assets/141305477/cfac8d2e-3806-4521-a0df-d9b768da2610" />
 
 
 
 
 8.  The message will be shown in the  `Type a message` field. Click on `Send` icon to send the message. You can edit the message, attach any file with the message, or simply remove it completely.
-<img width="1265" alt="SS SC5" src="https://github.com/glific/docs/assets/132430123/7adf1734-b169-4f7c-86bd-92707f01da4e" />
 
+<img width="993" alt="Screenshot 2024-03-04 at 2 48 50 PM" src="https://github.com/glific/docs/assets/141305477/5d379492-3405-4520-8e8d-9ab72c4dcca5" />
 
 
 
 ## Save Speed Sends
 1.  You can save any existing messages from chat from the little dropdown arrow shown next to the message. It will be saved in the Speed Sends list.
 
-<img width="902" alt="test" src="https://user-images.githubusercontent.com/143380171/268947000-6630694c-5b4a-4d9a-8bcd-bd43e5adc835.png"/>
+<img width="530" alt="Screenshot 2024-03-04 at 2 42 07 PM" src="https://github.com/glific/docs/assets/141305477/1979e9be-b117-4f02-805f-951c863d446e" />
 
 
 
 2. Enter the title of the message and click on `Save` button.
-
-![image](https://user-images.githubusercontent.com/32592458/212643585-4a1c33c9-7760-43b5-9ee8-07b884389672.png)
-
+<img width="429" alt="Screenshot 2024-03-04 at 2 41 30 PM" src="https://github.com/glific/docs/assets/141305477/a758345e-7c38-4dfd-9607-ce8b07009f5d" />
 
 
 3. Verify the message saved in Speed sends
 
-![image](https://user-images.githubusercontent.com/32592458/212643643-2f2e2a67-9236-48ad-bb81-37c08ae543ef.png)
+<img width="1289" alt="Screenshot 2024-03-04 at 2 42 52 PM" src="https://github.com/glific/docs/assets/141305477/4c759cfd-e762-4daf-b098-f40d159cc912" />