Merge pull request #1 from fleetbase/ron-v1-docs

First Version of Docs

.github/workflows/ci.yml

@@ -16,22 +16,47 @@ permissions:
 jobs:
   build:
     runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x]  # Build on Node.js 18
+
     env:
       GITHUB_PAGES_ENV: true
+
     steps:
       - name: Checkout
         uses: actions/checkout@v2
 
-      - name: Setup Node.js
-        uses: actions/setup-node@v3
+      - name: Setup Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v2.0.1
+        with:
+          version: latest
+
+      - name: Get pnpm Store Directory
+        id: pnpm-cache
+        shell: bash
+        run: |
+          echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
+    
+      - uses: actions/cache@v3
+        name: Setup pnpm Cache
         with:
-          node-version: 16.x
+          path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
 
       - name: Install dependencies
-        run: yarn install
+        run: pnpm install
 
       - name: Build
-        run: yarn build
+        run: pnpm build
 
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v1.0.8

docs/core-concepts/_category_.json

@@ -3,6 +3,6 @@
     "position": 4,
     "link": {
         "type": "generated-index",
-        "description": "Getting Started with using Fleetbase"
+        "description": "This section is designed to provide you with a foundational understanding of the Fleetbase platform, covering key aspects of its architecture, how to install and configure the system, manage upgrades, and troubleshoot common issues."
     }
 }

docs/core-concepts/contacts.md

@@ -3,3 +3,16 @@ title: Contacts
 sidebar_position: 5
 slug: /core-concepts/contacts
 ---
+
+## Overview
+
+Contacts are personal entities within Fleetbase, defined to manage relationships with individuals who may have various roles relative to the organization’s operations.
+
+## Attributes
+
+- **Type**: Defines the role or connection of the contact, such as customer, associate, subcontractor, or facilitator.
+
+## Functionality
+
+- **Role Definition**: Each contact’s role within the organization or projects is clearly defined, allowing for targeted interactions and management.
+- **Integration**: Contacts are easily integrated with other modules, such as orders or transactions, where personal oversight or interaction is required.

docs/core-concepts/drivers.md

@@ -3,3 +3,17 @@ title: Drivers
 sidebar_position: 6
 slug: /core-concepts/drivers
 ---
+
+## Overview
+
+Drivers are specialized users within Fleetbase who are qualified and licensed to operate vehicles for order facilitation.
+
+## Key Information
+
+- **Qualifications**: Details about licensing and qualifications that authorize a driver to operate specific types of vehicles.
+- **Assignment**: Drivers can be assigned to specific orders, linking them directly to the operational tasks.
+
+## Functionality
+
+- **Order Execution**: Critical for executing delivery and transportation orders within Fleetbase.
+- **Tracking and Management**: Enables detailed tracking of driver assignments and performance.

docs/core-concepts/orders.md

@@ -3,3 +3,77 @@ title: Orders
 sidebar_position: 1
 slug: /core-concepts/orders
 ---
+
+## Overview
+
+In Fleetbase, an Order represents a core resource that orchestrates the logistics and tracking of items from initiation to delivery. It encapsulates all details necessary to manage and track the movement of goods, including destinations, items (payload), configurations, and interactions with various system entities.
+
+## Structure of an Order
+
+### Destinations
+
+- **Pickup**: The starting point where items are collected.
+- **Dropoff**: The endpoint where items are delivered.
+- **Waypoints**: Intermediate stops included in the delivery route.
+
+### Payload
+
+- **Entities**: Represent the physical items being transported, such as containers, parcels, etc.
+
+### Additional Configuration
+
+- **Proof of Delivery (POD)**: Confirmation of delivery with evidence like signatures or photos.
+- **Ad-hoc (Adhoc)**: Indicates that the order is available for immediate fulfillment within a specific vicinity, usually near the pickup location.
+- **Dispatch**: Orders can be dispatched immediately upon creation unless scheduled for a later time.
+
+### Scheduling
+
+- **Scheduled Date**: Specifies the date and time an order is scheduled for dispatch. Upon reaching this scheduled time, the order will automatically be dispatched.
+
+### Assignments
+
+- **Driver Assigned**: Specifies the driver or delivery person assigned to the order.
+- **Vehicle Assigned**: Details the specific vehicle used to complete the order.
+
+## Order Configurations
+
+Defines the workflow and rules governing the lifecycle of an order, ensuring operational consistency and efficiency.
+
+<div style={{display: 'flex', textAlign: 'center', display: 'flex', alignItems: 'center', justifyContent: 'center'}}>
+    <img src="/img/order-config-activity-example.png" style={{width: '100%'}} />
+</div>
+
+### Activities
+
+- **Defined Activities**: Steps or events in an order’s lifecycle, from pickup to delivery.
+- **Logic and Events**: Control transitions between activities, with events triggered as activities change, facilitating system interactions.
+Custom Fields and Entities
+- **Custom Fields**: Additional data points attached to an order. For example, for a haulage order, a custom field could specify the vessel and its ETA for container pickup.
+- **Custom Entities**: Template-based entities that standardize the creation of new orders, enhancing the system's adaptability.
+
+## Facilitator
+
+Orders may be managed or executed by a facilitator, an external partner or a subcontracted entity, which broadens the operational network and fulfillment capabilities.
+
+## Quoting System
+
+Fleetbase dynamically generates service quotes based on the specifics of the order and predefined service rates.
+
+### Service Rates
+
+- **Service Rate Definitions**: Configured in the console to guide cost calculations for various order types and scenarios.
+
+## Documentation and Communication
+
+- **Files and Documents**: Attach important documentation directly to an order, such as shipping labels and customs forms.
+- **Comments**: Discussion threads attached to each order facilitate collaborative communication among stakeholders.
+
+## Tracking and Labels
+
+- **Tracking Number**: Generated upon order creation, enabling all parties to monitor the order's progress.
+- **Shipping Labels**: Generated based on the order details and shipping requirements.
+
+## Key Events in Order Lifecycle
+- **Created**: Marks the initiation of a new order.
+- **Dispatched**: Indicates that the order has been sent out for delivery.
+- **Completed**: Confirms the completion of the order and fulfillment of all conditions.

docs/core-concepts/places.md

@@ -3,3 +3,18 @@ title: Places
 sidebar_position: 3
 slug: /core-concepts/places
 ---
+
+## Overview
+
+Places are a foundational resource in Fleetbase, defining physical locations with detailed attributes for comprehensive geographic referencing.
+
+## Structure of an Place
+
+- **Name, Address Details**: Includes primary and secondary address lines, postal code, province/state, city, and country.
+- **Geographical Coordinates**: Locations can be defined using MySQL POINT or GeoJSON formats.
+- **Contact Information**: Places may include associated phone numbers.
+
+## Associations
+
+- **Contacts and Vendors**: Places can be linked to contacts or vendors, enhancing the utility of location data across various modules.
+- **Module Integration**: Used by the inventory module to define warehouses and by the storefront module for store locations.

docs/core-concepts/transactions.md

@@ -3,3 +3,16 @@ title: Transactions
 sidebar_position: 2
 slug: /core-concepts/transactions
 ---
+
+## Overview
+
+Transactions are a core resource in Fleetbase that handle financial data related to operations where money is involved. They are integral in capturing and managing the financial aspects of service operations.
+
+## Structure of an Transaction
+
+- **Transaction Items**: Detail each financial entry related to a transaction, such as subtotals for services rendered.
+
+## Key Features
+
+- **Comprehensive Tracking**: Transactions record detailed financial interactions, ensuring accurate accounting and financial management.
+- **Integration**: Seamlessly integrates with orders to automatically generate financial records upon order processing.

docs/core-concepts/vehicles.md

@@ -0,0 +1,19 @@
+---
+title: Vehicles
+sidebar_position: 7
+slug: /core-concepts/vehicles
+---
+
+## Overview
+
+Vehicles are core resources in Fleetbase that describe the transport assets used to facilitate orders.
+
+## Attributes
+
+- **Type and Specifications**: Includes details such as vehicle type, capacity, and operational specifications.
+- **Assignment**: Vehicles can be assigned to specific drivers and linked to particular orders.
+
+## Usage
+
+- **Logistical Operations**: Essential for carrying out physical movements and deliveries in the order fulfillment process.
+- **Maintenance Tracking**: Can be used to track maintenance schedules, operational availability, and performance.

docs/core-concepts/vendors.md

@@ -3,3 +3,16 @@ title: Vendors
 sidebar_position: 4
 slug: /core-concepts/vendors
 ---
+
+## Overview
+Vendors represent business entities that an organization interacts with, ranging from suppliers to collaborative partners in Fleetbase.
+
+## Key Attributes
+
+- **Type**: The nature of the business or the role of the vendor within the operations can be specified through a type attribute.
+- **Facilitation**: Vendors can act as facilitators for orders, playing a pivotal role in the supply chain.
+
+## Usage
+
+- **Business Relationships**: Defines and manages relationships with various business entities essential for operational success.
+- **Order Management**: Vendors can be integrated into the order management process, providing services or goods necessary for order fulfillment.