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 plugins built by the community. If you would like to have your plugin 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 probot/docs.

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

# Let's install some Ruby gems. Make sure your Ruby version is at least v2.2.0.
bundle install
# And let's get the probot/docs submodule started
# Note: --init is only needed the first time you run this command
git submodule update --init --recursive
# And lets run the website locally!
bundle exec jekyll serve

You should then be able to navigate to the URL printed in your console, 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 script. 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 chat with Probot users and contributors? Join us in Slack!

License

This website is licensed CC-BY-4.0 © 2018 Brandon Keepers. The Probot logo is licensed CC-BY-SA-4.0. It was found on wikimedia.org and is from clipartkid.com.