docs.hackerone.com

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

Getting started

Prerequisites

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

Installation

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

Running locally

1. yarn develop to start the hot-reloading development server (powered by Gatsby)
2. 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:

1. cd docs.hackerone.com to go into the project root
2. yarn deploy
3. 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

1. git checkout master from any folder in your local docs.hackerone.com repository
2. git pull origin master to ensure you have the latest main code
3. 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

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

Test the change

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

Push it

1. 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
2. git push my-fork-name the-name-of-my-branch
3. Go to the docs.hackerone.com repo, and you should see recently pushed branches.
4. Follow GitHub's instructions.
5. 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