docs.hackerone.com

This repo contains the source code and documentation powering docs.hackerone.com.

Getting started

Prerequisites

Git
Node: install version 16 or greater
Yarn: See Yarn website for installation instructions
A fork of the repo (for any contributions)
A clone of the docs.hackerone.com repo on your local machine

Installation

cd docs.hackerone.com to go into the project root
yarn to install the website's npm dependencies

Running locally

yarn develop to start the hot-reloading development server (powered by Gatsby)
open http://localhost:8000 to open the site in your favorite browser

Deploy

Deploys are automated using GitHub actions. Every commit to the master branch will trigger a script that will build and deploy the site to production. If you want to deploy manually, follow the steps below:

cd docs.hackerone.com to go into the project root
yarn deploy
wait a minute and open https://docs.hackerone.com/

Contributing

Guidelines

The documentation is divided into several sections with a different tone and purpose. If you plan to write more than a few sentences, you might find it helpful to get familiar with the contributing guidelines for the appropriate sections.

Create a branch

git checkout master from any folder in your local docs.hackerone.com repository
git pull origin master to ensure you have the latest main code
git checkout -b the-name-of-my-branch (replacing the-name-of-my-branch with a suitable name) to create a branch

Make the change

Follow the "Running locally" instructions
Save the files and check in the browser
Changes to React components in src will hot-reload
Changes to markdown files in docs will hot-reload
If working with plugins, you may need to remove the .cache directory and restart the server

Test the change

If possible, test any visual changes in all latest versions of common browsers, on both desktop and mobile.

Push it

git add -A && git commit -m "My message" (replacing My message with a commit message, such as Fixed header logo on Android) to stage and commit your changes
git push my-fork-name the-name-of-my-branch
Go to the docs.hackerone.com repo, and you should see recently pushed branches.
Follow GitHub's instructions.
If possible, include screenshots of visual changes.

Troubleshooting

yarn clean to clear the local gatsby cache
yarn reset to clear the local node.js cache