Skip to main content
Version: Next Gen

Get Started

Last updated on

When you're authoring content, you're working locally. So it's important to have the right tools installed.

note

This is a one-time setup.

Prerequisites​

  • Code editor, VS Code is recommended

  • Git

  • Node.js

  • Yarn

    You'll use the yarn package manager to build and view your changes in a browser window before submitting your pull request (PR).

Clone the repo​

  1. Clone the repo. This creates a directory named customer-docs in your current working directory.

    git clone https://github.com/gobeyondidentity/customer-docs.git
    cd customer-docs

  2. Next, create a new branch from main (always give your branch a meaningful, descriptive name).

    git checkout -b <branch_name> main

Refer to the contributor's guide for details on how to submit edits or additions to the documentation.

Start the development server​

We're finally able to get to the fun stuff! Install the dependencies and start a local development server:

yarn
yarn start

The http://localhost:3000 opens in your browser so you can see your changes reflected live. As you make changes to the source files, the preview build will be triggered automatically, and then you can refresh your browser to see the changes.