Skip to main content

Publishing the Doc

Now that your doc is ready, it's time to submit it to be added to the site. There are some protections in place to make sure you can't break anything, so don't worry!

If you have any questions about the git commands, check out Git Basics.

Make sure it builds​

yarn build

Stage the changes​

git add .
git status

If any files you don't want to commit are listed in the output of git status, restore them:

git restore <file>

Add a commit message​

git commit -m "Adding a new tutorial on blank"

Push your branch​

External contributors: push to your fork​

git push origin <your-branch-name>

Internal contributors: push to the main repo​

git push origin <your-branch-name>

(Since you cloned PaloAltoNetworks/pan.dev directly, origin already points to the main repo.)

Create a pull request​

External contributors (from a fork)​

  • The output of the git push will include a link like "Create a pull request for '<your-branch>' on GitHub by visiting…". Visit that link. It should look like:

    https://github.com/<your-username>/pan.dev/pull/new/<feature-branch>

If you don't see that link:

  • Go to https://github.com/<your-username>/pan.dev.
  • In the top-left corner under Code, where it says master, select the branch you made.
  • Just below that you'll see This branch is XX commits ahead of PaloAltoNetworks:master. Click the Contribute button next to it, then Open pull request.
  • Open a pull request from <your-username>/<your-feature> to PaloAltoNetworks/master.

Internal contributors (from the main repo)​

  • The output of the git push will include a link like "Create a pull request for '<your-branch>' on GitHub by visiting…". Visit that link. It should look like:

    https://github.com/PaloAltoNetworks/pan.dev/pull/new/<feature-branch>

If you don't see that link:

  • Go to https://github.com/PaloAltoNetworks/pan.dev/pulls.
  • Click New pull request, set the base to master and the compare branch to <your-branch-name>.

Check out the deploy preview​

Once the pull request is open, CI will build a Firebase Hosting preview and run automated checks (Playwright, link checks, etc.). The preview URL and check results are posted directly to the pull request.