This repo contains the source code and documentation powering docs.hackerone.com.
- Git
- Node: install version 8.4 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
cd docs.hackerone.comto go into the project rootyarnto install the website's npm dependenciesgatsby developto start the hot-reloading development server (powered by Gatsby)open http://localhost:8000to open the site in your favorite browsercd docs.hackerone.comto go into the project rootyarn deploy- wait a minute and open
https://docs.hackerone.com/ git checkout masterfrom any folder in your localdocs.hackerone.comrepositorygit pull origin masterto ensure you have the latest main codegit checkout -b the-name-of-my-branch(replacingthe-name-of-my-branchwith a suitable name) to create a branch- Follow the "Running locally" instructions
- Save the files and check in the browser
- Changes to React components in
srcwill hot-reload - Changes to markdown files in
docswill hot-reload - If working with plugins, you may need to remove the
.cachedirectory and restart the server - If possible, test any visual changes in all latest versions of common browsers, on both desktop and mobile.
git add -A && git commit -m "My message"(replacingMy messagewith a commit message, such asFixed header logo on Android) to stage and commit your changesgit 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.
yarn resetto clear the local cache
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.