Skip to content

Latest commit

 

History

History
58 lines (35 loc) · 1.72 KB

README.md

File metadata and controls

58 lines (35 loc) · 1.72 KB

Butler SOS documentation site

This repository contains the VitePress based documentation for Butler SOS, which is an open source monitoring tool for Qlik Sense.

The doc site created from this repository is available at butler-sos.ptarmiganlabs.com.

Development

To run the documentation site locally:

# Install dependencies
npm install

# Start the development server
npm run dev

# Build for production
npm run build

# Preview the production build
npm run serve

# Trigger deployment via GitHub Actions (requires GitHub CLI)
npm run deploy

Deployment

The site is automatically deployed to GitHub Pages via GitHub Actions when changes are pushed to the master branch.

Manual deployment options:

  1. Using npm command (requires GitHub CLI):

    npm run deploy

    This triggers the GitHub Actions workflow on your current branch.

  2. Using GitHub CLI directly:

    gh workflow run deploy-vitepress.yml

  3. Via GitHub web interface: Go to Actions → Deploy VitePress site to Pages → Run workflow

All methods use the same GitHub Actions workflow, ensuring consistent deployments.

Hugo Archive

The previous Hugo-based documentation site has been archived in the hugo-archive/ directory for reference and historical purposes. See the Hugo Archive README for information on how to run the archived Hugo site if needed.

Migration Documentation

Documentation about the VitePress migration process can be found in the vitepress-migration-docs/ directory.