Skip to content

hubDashboard

GitHub App

hubDashboard

GitHub App

Note

This app is currently under development. It is currently only available for hubs with quantile output types

The hubDashboard GitHub App will build a static website dashboard with forecast/nowcast visualization for your hub and deploy it to GitHub Pages. An example website can be found at https://hubverse-org.github.io/hub-dashboard-template/

Setup

There are three steps to install this app:

  1. create a new dashboard repository from the The Dashboard Template and select include all branches
    A GitHub Form for "Create a new repository" with the hub-dashboard-template shown as the template and a big red arrow pointing to a checked box that says "Include all branches"

  2. Use the "Configure" button to register this app with your new repository

  3. Set up your GitHub Pages by going to settings/pages and enabling your site to deploy from the gh-pages branch
    screenshot of the "Build and Deployment" section of the pages setting. There are two sub-headings that say "source" and "branch". The Source heading has a dropdown that is selected to "Deploy from a branch". The Branch heading shows a dropdown with gh-pages, main, ptc/data, and None as options for the "branch" dropdown. A red arrow is pointing to the gh-pages option, which is highlighted.

Operation

The app will use the information in your dashboard repository to generate predtimechart data from your hub (pushed to the ptc/data branch) and a static website (pushed to the gh-pages branch), and you can either use GitHub Pages or any other hosting service to display your dashboard.

Every time you push to your dashboard repository, the website will rebuild itself automatically and you can create issue comments (even on closed issues) to trigger a rebuild of the website and/or data by writing
/hub build <command> where <command> can be one of three keywords:

command action timeframe
site re-build the website 1 or 2 minutes
data re-build the targets and forecast data several minutes depending on the size of the hub
all re-build the data and the site several minutes depending on the size of the hub

Developer

hubDashboard is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

Report abuse