Merge branch 'shiv-guides' of github.com:fleetbase/docs into ron-v1-docs

fleetbase · May 28, 2024 · 5d0e866 · 5d0e866
2 parents a3a0812 + 9a2bc14
commit 5d0e866
Show file tree

Hide file tree

Showing 58 changed files with 430 additions and 44 deletions.
diff --git a/docs/guides/admin/image-1.png b/docs/guides/admin/image-1.png
diff --git a/docs/guides/admin/image-10.png b/docs/guides/admin/image-10.png
diff --git a/docs/guides/admin/image-11.png b/docs/guides/admin/image-11.png
diff --git a/docs/guides/admin/image-12.png b/docs/guides/admin/image-12.png
diff --git a/docs/guides/admin/image-2.png b/docs/guides/admin/image-2.png
diff --git a/docs/guides/admin/image-3.png b/docs/guides/admin/image-3.png
diff --git a/docs/guides/admin/image-4.png b/docs/guides/admin/image-4.png
diff --git a/docs/guides/admin/image-5.png b/docs/guides/admin/image-5.png
diff --git a/docs/guides/admin/image-6.png b/docs/guides/admin/image-6.png
diff --git a/docs/guides/admin/image-7.png b/docs/guides/admin/image-7.png
diff --git a/docs/guides/admin/image-8.png b/docs/guides/admin/image-8.png
diff --git a/docs/guides/admin/image-9.png b/docs/guides/admin/image-9.png
diff --git a/docs/guides/admin/image.png b/docs/guides/admin/image.png
diff --git a/docs/guides/admin/introduction.md b/docs/guides/admin/introduction.md
@@ -3,3 +3,89 @@ title: Introduction
 sidebar_position: 1
 slug: /guides/admin/introduction
 ---
+
+## Admin Overview
+
+The admin console is where you configure the system wide settings such as 3rd party services, billing configurations, visibility controls etc. 
+
+To access the system admin navigate to https://console.fleetbase.io/admin/
+
+### Organisations
+
+View all of the organisations and users signed up to your Fleetbase instance. 
+
+![Alt text](image.png)
+
+### Branding 
+
+Upload your icon and logo for branding your Fleetbase instance. 
+
+![Alt text](image-1.png)
+
+### Notifications 
+
+Set up users to recieve system wide notifications. 
+
+![Alt text](image-2.png)
+
+### 2FA Config 
+
+Configure the 2FA functions for your Fleetbase instance. 
+
+![Alt text](image-3.png)
+
+### Visibility Controls 
+
+Select which FleetOps modules are visibile to the users of your Fleetbase instance. 
+
+![Alt text](image-4.png)
+
+### Navigator App 
+
+To use our existing published Navigator App with your Fleetbase instance, you need to create a instance linking URL. You can do so in the screenshot below. 
+
+![Alt text](image-5.png)
+
+### Avatar Management 
+
+Create an upload the avatars that you want users to use in your Fleetbase instance for vehicles, places and drivers. 
+
+![Alt text](image-6.png)
+
+### Services
+
+Add in your API Keys for 3rd party services such as Google Maps, AWS, Twilio & Sentry in the Services section. 
+
+![Alt text](image-7.png)
+
+### Mail Config 
+
+Set up your mail server for sending emails from your Fleetbase instance.
+
+![Alt text](image-8.png)
+
+### Filestorage 
+
+Set up your file storage configurations so users can upload files in your Fleetbase instance. 
+
+![Alt text](image-9.png)
+
+### Queue Config 
+
+Set up your queue service for your Fleetbase instance. 
+
+![Alt text](image-10.png)
+
+### Socket Cluster 
+
+Test socket connection. 
+
+![Alt text](image-11.png)
+
+### Notification Channels
+
+Set up notifications system wide for your Fleetbase instance. 
+
+![Alt text](image-12.png)
+
+
diff --git a/docs/guides/developers-console/getting-started.md b/docs/guides/developers-console/getting-started.md
diff --git a/docs/guides/developers-console/image-1.png b/docs/guides/developers-console/image-1.png
diff --git a/docs/guides/developers-console/image-2.png b/docs/guides/developers-console/image-2.png
diff --git a/docs/guides/developers-console/image-3.png b/docs/guides/developers-console/image-3.png
diff --git a/docs/guides/developers-console/image-4.png b/docs/guides/developers-console/image-4.png
diff --git a/docs/guides/developers-console/image-5.png b/docs/guides/developers-console/image-5.png
diff --git a/docs/guides/developers-console/image.png b/docs/guides/developers-console/image.png
diff --git a/docs/guides/developers-console/introduction.md b/docs/guides/developers-console/introduction.md
@@ -3,41 +3,31 @@ title: Introduction
 sidebar_position: 1
 slug: /guides/console/introduction
 ---
-## What is FleetOps?
+## Overview
 
-FleetOps is a dynamic last-mile operations and fleet management system. 
+The Developers console allows you to have an overview of your activity, and create the API Keys and Webhooks you need to integrate and run Fleetbase programatically.
 
-### Dashboard
+1. **Insights** - View API insights.
 
-The Dashboard is your central place for operations. 
+![Alt text](image.png)
 
-- View Drivers on Map
-- Create Orders
-- View Orders
-- View Service Areas
-- Create Service Areas
-- Export Orders
+2. **API Keys** - Create and view API Keys. 
 
-### Service Rates
+![Alt text](image-1.png)
 
-### Scheduler
+3. **Webhooks** - Create and view webhook endpoints.
 
-### Drivers
+![Alt text](image-2.png)
 
-### Vehicles
+4. **WebSockets** - View your webhooks success and errors.
 
-### Fleets
+![Alt text](image-3.png)
 
-### Vendors
+5. **Logs** - View all of the logs for your account.
 
-### Contacts
+![Alt text](image-4.png)
 
-### Places
-
-### Fuel Reports
-
-### Issues
-
-### Navigator App
+6. **Events** - View all of the logs for your account.
 
+![Alt text](image-5.png)
 
diff --git a/docs/guides/fleet-ops/getting-started.md b/docs/guides/fleet-ops/getting-started.md
@@ -2,4 +2,92 @@
 title: Getting Started
 sidebar_position: 15
 slug: /guides/fleet-ops/getting-started
----
+---
+
+## Get Started With FleetOps ##
+
+### 1. Sign Up ###
+
+‍The first step to revolutionizing your logistics operations is to sign up for Fleetbase. It's as simple as following this link and filling in a few details.
+
+![Alt text](image-51.png)
+
+### 2. Invite Users ###
+
+Invite your team members to join the platform, assign roles, and empower everyone to contribute to your fleet's success.
+
+![Alt text](image-52.png)
+
+### 3. Download Driver App ###
+
+‍Download the Fleetbase Navigator App on your iOS or Android device to take your fleet management wherever you go.
+
+Once you create a Driver within Fleetbase you can login to the Navigator App using the mobile you have assigned to that Driver.
+
+![Alt text](image-53.png)
+
+### 4. Configure Your Operations Flow ###
+
+Fleetbase can be fully customised to for your operations flow, whether your company conducts food delivery, garage pick up, courier services or logistics operations processes.
+
+Head to the Order Config within Fleetbase and follow the below step: 
+
+1. Create New - Click 'New Order Config' and enter your operation flow details. ‍
+
+2. Custom Fields - Create as many custom fields as you like, these fields will appear in the Order Form
+
+3. Activity Flow - Create custom activity flow statuses. These status are each activity point the driver either needs to update or gets updated automatically.
+‍
+![Alt text](image-54.png)
+
+### 5. Create your Service Areas ###
+
+Define service areas and zones within Fleetbase to optimize your routes and streamline your deliveries.
+
+![Alt text](image-55.png)
+
+### 6. Set Up Custom Service Rates ###
+
+‍Our platform offers advanced algorithms to help you create custom service rates that reflect your business objectives.
+
+![Alt text](image-56.png)
+
+### 7. Invite Your Drivers ###
+
+‍Your drivers are the backbone of your fleet, and Fleetbase makes it easy to manage them efficiently. Add drivers to your fleet, track their assignments, and ensure seamless communication at all times.
+
+![Alt text](image-57.png)
+
+### 8. Equip Your Fleet ### 
+
+‍From trucks to vans to bikes, add vehicles to your Fleetbase account in Fleets and keep track of their performance, maintenance schedules, and more. Your fleet, your rules!
+
+![Alt text](image-58.png)
+
+### 9. Keep Contacts & Customers Organized ###
+
+‍Managing contacts is a breeze with Fleetbase. Add clients, suppliers, and partners to your contact list and streamline communication for smooth order processing.
+
+![Alt text](image-59.png)
+
+### 10. Manage Delivery Locations ###
+
+‍Simplify your delivery logistics by adding places to your Fleetbase account. Whether it's a client's office or a warehouse, easily access and manage all your delivery locations in one place.
+
+![Alt text](image-60.png)
+
+### 11. Seamlessly Create Orders ### 
+
+‍Ready to kickstart your operations? Create orders seamlessly within Fleetbase, specifying all the necessary details for smooth execution, from pickup to delivery.
+
+### 12. Stay Updated in Real-Time ###
+
+‍Keep track of your order's progress by updating its activity in real-time. From order acceptance to delivery confirmation, stay informed every step of the way.
+
+![Alt text](image-61.png)
+
+### 13. Close the Loop with POD ### 
+
+‍Complete proof of delivery (POD) for your orders to finalize the transaction and ensure customer satisfaction. Capture essential information such as signatures and timestamps to confirm successful deliveries.
+
+![Alt text](image-62.png)
diff --git a/docs/guides/fleet-ops/image-51.png b/docs/guides/fleet-ops/image-51.png
diff --git a/docs/guides/fleet-ops/image-52.png b/docs/guides/fleet-ops/image-52.png
diff --git a/docs/guides/fleet-ops/image-53.png b/docs/guides/fleet-ops/image-53.png
diff --git a/docs/guides/fleet-ops/image-54.png b/docs/guides/fleet-ops/image-54.png
diff --git a/docs/guides/fleet-ops/image-55.png b/docs/guides/fleet-ops/image-55.png
diff --git a/docs/guides/fleet-ops/image-56.png b/docs/guides/fleet-ops/image-56.png
diff --git a/docs/guides/fleet-ops/image-57.png b/docs/guides/fleet-ops/image-57.png
diff --git a/docs/guides/fleet-ops/image-58.png b/docs/guides/fleet-ops/image-58.png
diff --git a/docs/guides/fleet-ops/image-59.png b/docs/guides/fleet-ops/image-59.png
diff --git a/docs/guides/fleet-ops/image-60.png b/docs/guides/fleet-ops/image-60.png
diff --git a/docs/guides/fleet-ops/image-61.png b/docs/guides/fleet-ops/image-61.png
diff --git a/docs/guides/fleet-ops/image-62.png b/docs/guides/fleet-ops/image-62.png
diff --git a/docs/guides/iam/image.png b/docs/guides/iam/image.png
diff --git a/docs/guides/iam/introduction.md b/docs/guides/iam/introduction.md
@@ -1,5 +1,23 @@
 ---
 title: Introduction
 sidebar_position: 1
-slug: /guides/storefront/introduction
+slug: /guides/iam/introduction
 ---
+## Overview
+
+You can view all of your users, roles, groups and policies in the dashboard.
+
+### Users
+
+Add additional users to your organisation. You can then assign specific roles to these users or add them to groups.
+
+![Alt text](image.png)
+
+### Groups
+
+Add your existing users to groups to assign them to certain roles and policies.
+
+### Roles
+
+You can create specific roles which limit certain actions to Fleetbase features. Once you client New you can select which features are will be available for users or groups assigned to this role.
+
diff --git a/docs/guides/settings/_category_.json b/docs/guides/settings/_category_.json
diff --git a/docs/guides/settings/introduction.md b/docs/guides/settings/introduction.md
diff --git a/docs/guides/storefront/customers.md b/docs/guides/storefront/customers.md
@@ -0,0 +1,19 @@
+---
+title: Customers
+sidebar_position: 1
+slug: /guides/storefront/customers
+---
+
+## Customers
+
+View all customers by clicking on the customers section under Resources
+
+### Create Customers
+
+You can create new customers 2 ways:
+
+1. Customers are automatically created when customers order through your Storefront App
+
+2. You can also create Customers manually by clicking ‘New’ on the top right
+
+![Alt text](image-6.png)
diff --git a/docs/guides/storefront/image-1.png b/docs/guides/storefront/image-1.png
diff --git a/docs/guides/storefront/image-10.png b/docs/guides/storefront/image-10.png
diff --git a/docs/guides/storefront/image-11.png b/docs/guides/storefront/image-11.png
diff --git a/docs/guides/storefront/image-12.png b/docs/guides/storefront/image-12.png
diff --git a/docs/guides/storefront/image-2.png b/docs/guides/storefront/image-2.png
diff --git a/docs/guides/storefront/image-3.png b/docs/guides/storefront/image-3.png
diff --git a/docs/guides/storefront/image-4.png b/docs/guides/storefront/image-4.png
diff --git a/docs/guides/storefront/image-5.png b/docs/guides/storefront/image-5.png
diff --git a/docs/guides/storefront/image-6.png b/docs/guides/storefront/image-6.png
diff --git a/docs/guides/storefront/image-7.png b/docs/guides/storefront/image-7.png
diff --git a/docs/guides/storefront/image-8.png b/docs/guides/storefront/image-8.png
diff --git a/docs/guides/storefront/image-9.png b/docs/guides/storefront/image-9.png
diff --git a/docs/guides/storefront/image.png b/docs/guides/storefront/image.png
diff --git a/docs/guides/storefront/introduction.md b/docs/guides/storefront/introduction.md
@@ -3,3 +3,17 @@ title: Introduction
 sidebar_position: 1
 slug: /guides/storefront/introduction
 ---
+
+## Overview
+
+Storefront is a headless e-commerce service which functions as an extension within Fleetbase
+
+Fleetbase Storefront provides several API-first approaches to products, carts, categories, customers, and checkout flow giving developers more control over the shopping experience.
+
+This project is to provide an open-sourced hyperlocal shopping app which can be fully customised and adapted to personal and commercial projects.
+
+This Storefront app is built with React Native to provide react native developers a head start building with Fleetbase and Storefront.
+
+The dashboard is where you can manage all of your orders, customers, stores and current earnings.
+
+![Alt text](image-8.png)
diff --git a/docs/guides/storefront/networks.md b/docs/guides/storefront/networks.md
@@ -0,0 +1,64 @@
+---
+title: Networks
+sidebar_position: 1
+slug: /guides/storefront/networks
+---
+
+## Networks
+
+Storefront allows you to quickly create marketplaces, enabling multiple storefronts to sell under an umbrella. When you create the network you define your rules and you're able to expand your network through invitations..
+
+### Create Networks
+
+You can create new Network by clicking on the button on the top of the panel.
+
+1. **Name** - The name of the network.
+2. **Description** - The description of the network.    
+2. **Currency** - The currency of the network. 
+
+![Alt text](image.png)
+
+### Network Settings
+
+Configure the main settings of your network. 
+
+![Alt text](image-1.png)
+
+1. **Name** - The name of your network.
+2. **Description** - The description of the network.  
+2. **Tags** - Create tags for this Storefront to be selected on your app.  
+2. **Currency** - The currency of the network. 
+2. **Contact & Social** - Add contact details and social media accounts to be shown on your storefront app.
+2. **Logo & Backdrop** - Add in a logo and your backdrop for your network.
+2. **Images & Videos** - Add images & videos to your network.  
+2. **Alerts** - You can add users in your organisation to receive alerts for new orders that are placed on your Storefront App. 
+2. **Online** - Toggle if this network is online and available on your Storefront app.
+2. **Enable Tax** - Toggle this to enable a tax percentage on this network orders.
+2. **Auto Accept** - Toggle this to auto accept orders when placed by your customers on the Storefront App.
+2. **Require Proof of Delivery** - Select whether proof of delivery is required on your network orders. Select the type of POD using the drop down.
+2. **Enable Cash on Delivery** - Toggle for cash on delivery option for the orders in the network.
+2. **Enable Order PickUp** - Toggle this for the option for your customers to collect orders from your network locations.
+2. **Enable Tips** - Toggle for allowing tips on orders.
+2. **Enable Delivery Tips** - Toggle for allowing tips for drivers on orders. 
+2. **Enable Multi-cart Checkout** - Toggle this to allow customers to order products / services from multiple vendors.
+**Enable User Reviews** - Enable your customers to leave reviews on the individual Storefronts.
+
+### Stores ###
+
+You can invite and add multiple stores to your network. 
+
+![Alt text](image-2.png)
+
+
+### Orders ###
+
+View all of the orders that have been recieved from this network. 
+
+![Alt text](image-3.png)
+
+### Customers ###
+
+View all of the customers that have been created from this orders in this network. 
+
+![Alt text](image-4.png)
+