Google Sign-In Required

Use your company Google account to access the BetterFleet private content.

Back to private home

BetterFleet Support Private
Skip to content
BetterFleet Dev Wiki
Publishing
Initializing search
    bf-dev
    • Home
    • Product Capabilities
    • Process
    • Current Work
    • System Design
    • Software Reference
    • Operations
    bf-dev
    • Home
      • Overview
      • Manage
      • Overview
      • Product Engineering Workflow
      • Product Engineering Delivery
      • Product Engineering Workflow in Linear
        • GitLab Feature Flags
        • In-App Docs Authoring
        • Release Notes
      • Templates
      • Publishing
      • Workflow Companions
      • Overview
      • Active Artifacts
      • Backlog Artifacts
      • Archived Artifacts
      • Overview
      • Microgrid
      • OSCP
        • Challenge
        • Specification
        • Spec
        • Architecture
        • Overview
        • Script Runtime Model
        • Compose Profiles and Modes
        • Repo Topology
        • CI and Release Integration
        • Overview
        • Internal Application Diagrams
          • Overview
          • Web Model
          • Core Model
        • Service Interaction Flows
        • Data and State
          • Index
          • bf-manage-web
          • bf-manage-core
          • bf-manage-connect
          • bf-manage-sitepwrmon
          • bf-manage-incidents
          • bf-telematics
          • bf-depot-sim
          • bf-manage-roaming
          • bf-support-microsite
          • bf-digital-twin
          • bf-schedule-creator
        • Overview
        • Internal Application Diagrams
        • Migration and Flags
        • Simulation Request Lifecycle
          • Index
          • bf-bnl-ui
          • bf-bnl-settings
          • bf-bnl-schedule-analysis-compute
          • bf-route-modelling
          • bf-schedule-creator
          • bf-digital-twin
        • Overview
        • Secrets and Env Strategy
        • Vendors and Local Dependencies
        • ADRs
        • Service Matrix
        • Cloud Dependencies
        • Ports and URLs
      • Onboarding
      • Daily Operations Runbook
        • Overview
        • Staging Hotfix Release
        • Production Hotfix Release
        • Terraform Plan Dry Runs
      • Troubleshooting
      • Testing Guide

    Process Publishing¶

    Everything under docs/ publishes to the support microsite, in the private section.

    Rules: - Treat the docs/ tree as the canonical source. - Publish the docs/ tree to the support microsite private section. - Do not create a second source of truth while publishing. - When adding, renaming, or moving a BFDev docs page, update mkdocs.yml and any relevant handbook or section index pages so the page is reachable in the published site. - Treat broken navigation or orphaned pages as incomplete documentation work.

    Actual publication behaviour: - Maintainers publish locally with ./publish-docs, which builds the BFDev MkDocs site and stages the generated output into the checked-out bf-support-microsite repo under public/private/bf-dev/. - BFDev CI owns the automated sync in the separate include file .gitlab/docs-publish.yml. - The docs CI job runs only when BFDev docs publishing inputs change on the default branch. - The automated job clones support-microsite, runs ./publish-docs, and pushes the updated generated docs when there is a diff. - bf-support-microsite serves the published output; it is the serving target, not the canonical authored source. - BFDev docs publication depends on CI credentials that can push to support-microsite.

    Made with Material for MkDocs