Hacker0x01 / Docs.hackerone.com
Licence: other
HackerOne Platform Documentation
Stars: ✭ 137
Programming Languages
javascript
184084 projects - #8 most used programming language
Labels
Projects that are alternatives of or similar to Docs.hackerone.com
Foliant
Comprehensive markdown-based documentation toolkit
Stars: ✭ 74 (-45.99%)
Mutual labels: documentation, docs
Github Template Guidelines
Guidelines for building GitHub templates.
Stars: ✭ 137 (+0%)
Mutual labels: documentation, docs
Zeal
Offline documentation browser inspired by Dash
Stars: ✭ 9,164 (+6589.05%)
Mutual labels: documentation, docs
Docsify Tabs
A docsify.js plugin for rendering tabbed content from markdown
Stars: ✭ 65 (-52.55%)
Mutual labels: documentation, docs
Pyspark Cheatsheet
🐍 Quick reference guide to common patterns & functions in PySpark.
Stars: ✭ 108 (-21.17%)
Mutual labels: documentation, docs
Quickstart
🎯 A micro-form for user-specific installation instructions
Stars: ✭ 66 (-51.82%)
Mutual labels: documentation, docs
Docpht
With DocPHT you can take notes and quickly document anything and without the use of any database.
Stars: ✭ 90 (-34.31%)
Mutual labels: documentation, docs
Feedmereadmes
Free README editing+feedback to make your open-source projects grow. See the README maturity model to help you keep going.
Stars: ✭ 1,064 (+676.64%)
Mutual labels: documentation, docs
Learn
👩🏫 Learn how to use RunwayML with tutorials, guides, and examples!
Stars: ✭ 95 (-30.66%)
Mutual labels: documentation, docs
Jekyll Rtd Theme
Just another documentation theme compatible with GitHub Pages
Stars: ✭ 92 (-32.85%)
Mutual labels: documentation, docs
Nord Docs
The official Nord website and documentation
Stars: ✭ 63 (-54.01%)
Mutual labels: documentation, docs
Catalog
Create living style guides using Markdown or React
Stars: ✭ 1,527 (+1014.6%)
Mutual labels: documentation, docs
Docnado
Rapid documentation tool that will blow you away...
Stars: ✭ 67 (-51.09%)
Mutual labels: documentation, docs
Parse Comments
Parse JavaScript code comments. Works with block and line comments, and should work with CSS, LESS, SASS, or any language with the same comment formats.
Stars: ✭ 53 (-61.31%)
Mutual labels: documentation, docs
Community
Modern Confluence alternative designed for internal & external docs, built with Golang + EmberJS
Stars: ✭ 1,286 (+838.69%)
Mutual labels: documentation, docs
Jsdoc Baseline
An experimental, extensible template for JSDoc.
Stars: ✭ 51 (-62.77%)
Mutual labels: documentation, docs
Gatsby Documentation Starter
Automatically generate docs for React components using MDX, react-docgen, and GatsbyJS
Stars: ✭ 91 (-33.58%)
Mutual labels: documentation, docs
Ikea Tradfri Coap Docs
How can you communicate to your ikea tradfri gateway/hub through coap-client
Stars: ✭ 111 (-18.98%)
Mutual labels: documentation, docs
docs.hackerone.com
This repo contains the source code and documentation powering docs.hackerone.com.
Getting started
Prerequisites
- 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
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 localdocs.hackerone.com
repository -
git pull origin master
to ensure you have the latest main code -
git checkout -b the-name-of-my-branch
(replacingthe-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"
(replacingMy message
with a commit message, such asFixed 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
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].