HackerOne Platform Documentation
This repo contains the source code and documentation powering docs.hackerone.com.
cd docs.hackerone.com
to go into the project rootyarn
to install the website's npm dependenciesyarn develop
to start the hot-reloading development server (powered by Gatsby)open http://localhost:8000
to open the site in your favorite browserOn some machines you'll receive an error like:
Generating development SSR bundle failed
error:0308010C:digital envelope routines::unsupported
Run the following command to use the legacy OpenSSL provider instead:
export NODE_OPTIONS=--openssl-legacy-provider
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 rootyarn deploy
https://docs.hackerone.com/
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.
git checkout master
from any folder in your local docs.hackerone.com
repositorygit pull origin master
to ensure you have the latest main codegit checkout -b the-name-of-my-branch
(replacing the-name-of-my-branch
with a suitable name) to create a branchsrc
will hot-reloaddocs
will hot-reload.cache
directory and restart the servergit 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 changesgit push my-fork-name the-name-of-my-branch
yarn clean
to clear the local gatsby cacheyarn reset
to clear the local node.js cache