Skip to content
Zipline Zipline Service Documentation

    Appendix B - Windows setup

    Use this appendix if you are setting up service_docs on Windows for the first time.

    This is the native Windows setup that matches a VS Code + PowerShell workflow.

    Install Git for Windows

    Section titled “Install Git for Windows”

    Download Git from the Git downloads page.

    During installation, these options make the later workflow easier:

    • Add “Open with Code” action
    • Add Git to PATH
    • Use VS Code as the default editor if that option appears

    After installation, open PowerShell and verify:

    Terminal window
    git --version

    Install Node.js LTS

    Section titled “Install Node.js LTS”

    Download Node.js from the Node.js download page.

    Install the LTS version of Node.js. Node.js also installs npm, which is the tool you use later to run npm ci and npm run dev.

    Verify in PowerShell:

    Terminal window
    node --version
    npm --version

    If both commands show version numbers, Node.js and npm are installed.

    Clone the repository

    Section titled “Clone the repository”

    In VS Code:

    1. Open the Source Control view.

    2. Choose Clone Repository.

    3. Paste:

      https://github.com/ZiplineTeam/service_docs.git

    4. Choose a local folder, such as C:\GitHub.

    5. Open the cloned service_docs folder when VS Code asks.

    You can also clone from PowerShell:

    Terminal window
    cd C:\GitHub
    git clone https://github.com/ZiplineTeam/service_docs.git
    cd service_docs

    If clone fails with a permission error, confirm that you are signed in to the right GitHub account and use Appendix D - Check GitHub access to check your repo and write access.

    Install site dependencies

    Section titled “Install site dependencies”

    From the repo root, install the Troubleshooting dependencies:

    Terminal window
    npm ci --prefix site

    Optional: WSL2 setup

    Section titled “Optional: WSL2 setup”

    Some engineers prefer WSL2 because its shell behavior is closer to Linux and CI. If you use WSL2, clone the repo inside your Linux home directory, not on a mounted Windows drive.

    Inside WSL:

    Terminal window
    sudo apt update
    sudo apt install -y git curl
    curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash
    source ~/.bashrc
    nvm install --lts
    nvm use --lts
    git clone https://github.com/ZiplineTeam/service_docs.git
    cd service_docs
    npm ci --prefix site

    Continue

    Section titled “Continue”

    After the repo opens in VS Code, continue with Set up your workspace.