Skip to content
Compuware edited this page Apr 8, 2019 · 11 revisions

Welcome to the DevOps-Examples-Doc wiki!

Local Development Instructions

Install Prerequisites

Setup your local environment

  • Clone this repo 'git clone https://github.com/cpwr-devops/DevOps-Examples-Doc.git'
  • Open the Folder you cloned this repo to in Visual Studio Code (File/Open Folder)
  • In Visual Studio Code, Open a Bash Terminal Window (Terminal/New Terminal)
  • In terminal execute 'npm install'. You can ignore the warnings
  • In terminal execute 'npm run docs:dev'
  • Once the build completes successfully, you should see something similar to this: DONE [16:53:13] Build 1dc630 finished in 238 ms! (http://localhost:8080/)
  • Click the link to see a local instance of the doc site. If you have trouble loading it, make sure the URL is just http://localhost:8080 and doesn't have any extra chars like )

Publishing a change

  • Ensure you are a collaborator for this repo
  • Create a new branch in github (on the Code page, select Branch Drop down and then type in branch name)
  • Clone the new branch locally
  • When you are complete with your changes, create a Pull Request from your branch to the master branch
  • Once the change is merged, the Production site will automatically be rebuilt with the new changes

This is the production URL for the site: https://devops.api.compuware.com

This is a netlify URL to the site. This should not be used normally: https://stupefied-morse-75ab2e.netlify.com/