Skip to main content

GitHub & Development Environment

tip

If you don't already have a GitHub account, sign up here.

Fork or clone the repository​

Which path you take depends on whether you have write access to PaloAltoNetworks/pan.dev:

  • External contributors (no write access): fork the repo, then clone your fork.
  • Palo Alto Networks org members / internal contributors (write access): clone the main repo directly and branch from master — no fork needed.

External contributors: fork, then clone​

Fork the Repository

note

"Forking" copies and links a repository to your personal GitHub account.

git clone https://github.com/YOUR_USERNAME/pan.dev.git

Internal contributors: clone directly​

git clone https://github.com/PaloAltoNetworks/pan.dev.git

Change to the repo directory​

cd pan.dev

Install dependencies​

yarn install
HELP
Getting an error while installing dependencies?

"Self-signed certificate in certificate chain" issues can be solved by running:

yarn config set strict-ssl false

GlobalProtect can sometimes prevent some packages from being installed. If you suspect this is happening, temporarily disable GP to complete the installation.

Create a feature branch​

git checkout -b <branch-name>
tip

Give your branch a descriptive name appropriate for the change you are making.

Start a local development server​

yarn start

This command starts a local instance of the site at http://localhost:3000. It updates on most saved changes; if it doesn't update, hit CTRL+C and run again.

Now that you have the local website up and running, we'll start to author the doc.