Skip to content

Static web page(s) used to display messages during outages and other special events

Notifications You must be signed in to change notification settings

microbiomedata/nmdc-status-website

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

nmdc-status-website

This repository contains static web page(s) the NMDC team uses to display messages during outages and other special events.

It is hosted at: https://status.microbiomedata.org/

Usage

Updating the text

Write the text in Markdown format in the file ./message.md, then reload the web page (i.e. index.html). The reloaded web page will show the message in a box below the words, "We'll be right back."

If the ./message.md file is empty, the web page will show a default message saying all systems are running normally.

Deployment

GitHub will automatically deploy the latest commit on the main branch, to GitHub Pages.

Design

The website is built upon the Bootstrap 5 web UI framework.

Typography

The font was chosen in an attempt to match the NMDC website.

font-family: Arimo,sans-serif

Color palette

The color scheme was chosen in an attempt to match the NMDC website.

:root {
  --nmdc-white: #ffffff;
  --nmdc-black: #000000;
  --nmdc-blue: #02aae7;
  --nmdc-orange: #ee5338;
  --nmdc-purple: #4f3b80;
  --nmdc-light-gray: #f5f5f5;
  --nmdc-light-blue: #edf9fd;
}

In ./index.css, these colors are defined using CSS custom properties.

Search engine behavior

The ./robots.txt file contains the following, which tells all robots (e.g. web crawlers) we don't want them to visit any pages of the website. It's up to them to respect that, though.

User-agent: *
Disallow: /

Reference: robotstxt.org

Text

The website's text is written in Markdown format. I implemented things that way in an attempt to make it easier for team members who are familiar with Markdown—but not with HTML—to update the website.

The website uses a JavaScript library named Showdown to convert that Markdown into HTML. The conversion process happens when the web browser loads the web page.

Google Analytics

This website currently does not use Google Analytics.

Sources

The following files in this repository were copied from the NMDC website: