Before you start

• Make sure you have node and npm installed

• npm run init

Generate the docs

• npm run build

• gulp open

This documentation is generated from https://github.com/maistra/istio-workspace/tree/docs

Preview Mode

This project comes with a preview mode too, using which you can instantly see the changes of the docs you are working on.

To use it, please do the following:

1. Install dependencies.

   npm run init

2. Install the LiveReload chrome extension.

3. Start the preview mode. Assuming docs and source repositories directories live next to each other (e.g. in the same parent folder) you can simply run npm rum preview. This will build docs against currently active branch in the source repository.

   If your documentation source directory lives somewhere else you can directly gulp instead.

   gulp -d DOCS_DIRECTORY

   Where DOCS_DIRECTORY points to your local clone of https://github.com/maistra/istio-workspace/tree/docs.

   Important

   By default it will use master branch. If you want other branch you can pass it in -b flag

4. The console output will print status information every time a change is detected.

   [20:09:56] Starting 'connect'...
   [20:09:56] Starting server...
   [20:09:56] Finished 'connect' after 4.96 ms
   [20:09:56] Starting 'watch'...
   [20:09:57] Finished 'watch' after 952 ms
   [20:09:57] Starting 'build'...
   [20:09:57] Istio Workspace Antora Doc Server started http://localhost:5353
   [20:09:57] LiveReload started on port 35729
   [20:09:57] Running server

5. Make changes to your AsciiDoc files locally.

   The browser tab should automatically reload after a short while.