Skip to content

wmde/wikibase-cloud-status

Folders and files

NameName
Last commit message
Last commit date

Latest commit

0bf0b98 · Dec 12, 2024

History

33 Commits
May 14, 2024
Dec 12, 2024
Dec 4, 2024
May 14, 2024
May 8, 2024
May 14, 2024
May 8, 2024
May 14, 2024
May 14, 2024
Dec 2, 2024
Aug 28, 2024
May 14, 2024

Repository files navigation

status-page

This repository contains the source code for the wikibase.cloud status page.

Adding an incident

In the event of an incident, in addition to reporting it in the incidents mattermost channel you should add and incident here. This is done by adding a markdown file to the issues folder. You can follow the example of other incidents to complete the template. Unlike our normal code repositories it is acceptable to self-merge PRs in this repo.

Deployment

The status page is deployed to GitHub pages and will be built on each push to the main branch.

Deploying a preview for review

You can use a fork of this repository to deploy any branch as a preview for review via GitHub Pages.

  1. Fork this repository: https://github.com/wmde/wikibase-cloud-status/fork
    • De-select Copy the main branch only (otherwise you have to sync your branch after forking)
  2. Enable GitHub Pages
    • Settings -> Pages and select GitHub Actions as the source
  3. Adjust allowed branches for Pages
    • Settings -> Environments -> github-pages and edit the allowed branches from main to *
  4. Run workflow Deploy Hugo site to Pages
    • Actions -> agree to enable them -> workflow Deploy Hugo site to Pages -> Run workflow with the branch you want

The setup is only needed once, you can keep the fork and in case you need to do use this again you just need to sync the branch of your choice and repeat step 5.

Local development

Important: The cstate theme is distributed as a git submodule contained in this repository, and is not pulled by default. To obtain the theme, you can either use --recursive when cloning:

git clone --recursive git@github.com:wbstack/status-page.git

or init submodules from within the repository root

git submodule update --init

To develop the site locally, use the existing docker compose setup. Running

docker compose up

which will start a live-reloading server on http://localhost:1313.

Licenses

All source code in this repository is licensed under the BSD-3.0 License. Page content is licensed as CC-BY-SA 4.0.