jakebolam / probot.github.io Goto Github PK

View Code? Open in Web Editor NEW

This is the home of probot documentation, apps, how-to guides and more.

License: Creative Commons Attribution 4.0 International

HTML 99.31% Ruby 0.01% CSS 0.68% JavaScript 0.01% Shell 0.01%

probot.github.io's Introduction

probot.github.io

This is the home of probot.github.io, a website for probot documentation, apps, how-to guides and more.

Documentation

The majority of documentation on the site is drawn from the probot docs. If you have requests for documentation additions to probot, please open an issue in probot/probot, or if you want to add them yourself, feel free to open a pull request there.

App Showcase

We also use this website to show off some of the cool probot apps built by the community. If you would like to have your app listed there, check out our Contributing Guidelines for more information about what the requirements are to do that.

Install and Usage

If you'd like to work on this repository, clone it. We use Jekyll to build the website, hosted on GitHub Pages. We also use Git submodules to pull docs from the docs folder in probot/probot.

Once you've cloned this repo, run these commands in this directory:

# Only needed the first time:
$ script/bootstrap
# And each time you work locally:
$ script/server
# Below is the expected output:
Server address: http://127.0.0.1:4000
Server running... press ctrl-c to stop.

You should then be able to navigate to the server address, and see live edits you make render in your browser. You'll likely have to familiarize yourself with how Jekyll works to do larger edits, but it's worth the effort!

Another note: You can see more commands we use, such as our native build and server functions, in the script folder. Go take a look!

Contribute

We'd love to have you contribute! PRs are gladly accepted, and issues are also great. If you're thinking about a major PR, it would be better to open an issue first to talk about it.

If you're interested in contributing, check out our contributing docs to get started.

Want to get more involved with the Probot community? Take a look at our community page!