digital-apis-internal-docs v1.0.1

Digital APIs Internal Documentation

Static website serving oncall access checklist and internal documentation for the services offered by the Digital APIs team.

Oncall checklists

Per-person checklists can be found under docs/05-oncall-how-to/general/checklist directory. There is also a template for new checklists you can use for creating your own: Checklist.md.

API docs

API docs are located under docs/03-api-detais folder.

Tables of Contents

Many portions of this documentation have tables of contents, but these are not automatically generated. If you add a new page, you will need to edit

• The README.md for that section (such as the one for Infrastructure)
• The main index.md landing page
• The sidebar in docs/.vuepress/config.js

Getting Started

These instructions will get you a copy of the project up and running on your local macOS machine.

Prerequisites

Installing Node.js and npm

Use the current Node.js LTS release from https://nodejs.org/en/.

By default, all WestJet products should be built and run with current LTS. Please see the Node.js LTS release schedule

Clone and install dependencies

git clone https://westjet@dev.azure.com/westjet/Digital/_git/digital-apis-internal-docs

cd digital-apis-internal-docs

npm i

Run locally

Start the web server at http://localhost:8080/

npm run docs:dev

Notes

• Markdown Table Formatter - Beautifies your Markdown tables

Built With

• VuePress - Static Site Generator
• npm - Package manager