The IBM Cloud Enterprise Run Books help IBM Cloud operations teams managing Enterprise Subscription Account. A Run Book is description here, this is summarised with this sentence. In a computer system or network, a runbook is a compilation of routine procedures and operations that the system administrator or operator carries out. System administrators in IT departments and NOCs use runbooks as a reference. Runbooks can be in either electronic or in physical book form. Typically, a runbook contains procedures to begin, stop, supervise, and debug the system. It may also describe procedures for handling special requests and contingencies. An effective runbook allows other operators, with prerequisite expertise, to effectively manage and troubleshoot a system.
The rendered Run Books can be viewed here - https://github.com/ibm-gsi-ecosystem/ibm-enterprise-runbooks
To update and manage the Run Books follow these steps.
git clone
npm install
This will install all the dependencies necessary to run the environment in development mode and to build and publish the content.
Most notably, this project depends on the following:
(documented in package.json):
npm install -g gatsbyThe content of the Developer Guide is authored through a hybrid of Markdown and React. The content itself is primarily provided using Markdown. React components are sprinkled into the Markdown to provide for a richer and more interactive set of components in the published guide.
To render the content within your local development environment, run the following:
npm run build
npm run dev
Test Local View your locally rendered content:
http://localhost:8000/
This repository has been configured to build and publish the changes automatically via travis-ci. There are two builds currently configured:
masterbranch is automatically published to thegh-pagesbranch in this repository which is visible here - https://ibm-gsi-ecosystem.github.io/ibm-enterprise-runbooks/
Note: There is a time delay between when deploy process completes and when the content is available on the published site.
Get started using with the Gatsby Carbon theme which includes all configuration you might need to build a beautiful site inspired by the Carbon Design System.