From b98160c1542c728a4db9f1a96b3917d9d59c352d Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Fri, 18 May 2018 16:30:23 -0400 Subject: [PATCH 01/10] docs: add install and usage, contribute, and @bkeepers to license --- README.md | 32 ++++++++++++++++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 31df035..57087a3 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # probot.github.io -This is the home of probot.github.io, a website for [probot](https://github.com/probot/probot) documentation, apps, how-to guides and more. +This is the home of probot.github.io, a website for [probot](https://github.com/probot/probot) documentation, apps, how-to guides and more. ## Documentation @@ -10,6 +10,34 @@ The majority of documentation on the site is drawn from [the probot docs](https: 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](https://github.com/probot/probot.github.io/blob/master/CONTRIBUTING.md) 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](https://jekyllrb.com/) to build the website, hosted on [GitHub Pages](https://pages.github.com/). We also use Git submodules to pull docs from [probot/docs](http://github.com/probot/docs). + +Once you've cloned this repo, run these commands in this directory: + +```sh +# 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](CONTRIBUTING.md) to get started. + +Want to chat with Probot users and contributors? [Join us in Slack](https://probot-slackin.herokuapp.com/)! + ## License -This website is licensed [CC-BY-4.0](LICENSE). The Probot logo is licensed [CC-BY-SA-4.0](https://creativecommons.org/licenses/by-sa/4.0/deed.en). It was found on [wikimedia.org](https://commons.wikimedia.org/wiki/File:Robot-clip-art-book-covers-feJCV3-clipart.png) and is from clipartkid.com. +This website is licensed [CC-BY-4.0](LICENSE) © 2018 Brandon Keepers. The Probot logo is licensed [CC-BY-SA-4.0](https://creativecommons.org/licenses/by-sa/4.0/deed.en). It was found on [wikimedia.org](https://commons.wikimedia.org/wiki/File:Robot-clip-art-book-covers-feJCV3-clipart.png) and is from clipartkid.com. From 2b98362921b35654855bb3891c5708693c298eed Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Fri, 18 May 2018 16:31:10 -0400 Subject: [PATCH 02/10] feat: add more instructions You need to gem install bundle if it isnt installed yet, and recursive gets submodules in cases where init doesnot, I think. --- script/bootstrap | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/script/bootstrap b/script/bootstrap index 33a4d47..01dbd7b 100755 --- a/script/bootstrap +++ b/script/bootstrap @@ -4,9 +4,10 @@ set -e export CC=gcc echo "==> Installing gem dependencies…" +gem install bundle bundle check --path vendor/gems 2>&1 > /dev/null || { time bundle install --binstubs bin --path vendor/gems } echo "==> Getting submodule for docs…" -git submodule update --init +git submodule update --init --recursive From 7faccb8544a85fbc0bf2fbbbece579fa1540f92e Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Fri, 18 May 2018 16:31:26 -0400 Subject: [PATCH 03/10] docs: add issues and bots sections, link to Slack --- CONTRIBUTING.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9d35fec..cd02925 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,6 +9,16 @@ Hi there! We're thrilled that you'd like to contribute to this project. Your hel Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms. +Want to chat with Probot users and contributors? [Join us in Slack](https://probot-slackin.herokuapp.com/)! + +## Issues + +We'd love you to open issues, if they're relevant to this repository: feature requests, bug reports, questions about our processes, declarations of gratefulness, etc. are all welcome. + +In particular, if you have a large PR you want to send our way, it may make sense to open an issue to discuss it with the maintainers first. + +We also use the label 'help wanted' to show issues we want help on! If you'd like to get started working in this repository, it'd be best to jump into those issues. + ## Submitting a pull request 0. [Fork][fork] and clone the repository @@ -71,3 +81,13 @@ Any documentation can go here. Many apps just use their README.md here. - Has a license - Has a code of conduct - Has someone willing to at least minimally maintain them for the near future + + +## Bots + +We have one bot enabled on this repo: + +- [Stale](https://probot.github.io/apps/stale/): We use Stale to ensure that conversations here remain relevant. This is for us, the maintainers, so that we don't feel like we've got hundreds of issues to deal with; if you still have an issue, please let us know! We don't want to close issues that are painful for you. Stale just helps us have a bit more breathing space by making sure issues don't pile up forever. + +If you're concerned about our bots or feel that they are insensitive in some way, please let us know. + From a6bfb9598104a81dc6c2e88dbf1f063b15931daf Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Thu, 31 May 2018 10:01:31 -0400 Subject: [PATCH 04/10] docs: Use scripts instead of new code block --- README.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 57087a3..c57e1a6 100644 --- a/README.md +++ b/README.md @@ -17,13 +17,10 @@ If you'd like to work on this repository, clone it. We use [Jekyll](https://jeky Once you've cloned this repo, run these commands in this directory: ```sh -# 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 +# Only needed the first time: +script/bootstrap +# And each time you work locally: +script/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! From f0e08e65cbb9a562b4cfc5bae8982494383b57bc Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Thu, 31 May 2018 10:06:18 -0400 Subject: [PATCH 05/10] docs: change bot to apps --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cd02925..ff49bde 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -83,11 +83,11 @@ Any documentation can go here. Many apps just use their README.md here. - Has someone willing to at least minimally maintain them for the near future -## Bots +## Apps -We have one bot enabled on this repo: +We have one app enabled on this repo: - [Stale](https://probot.github.io/apps/stale/): We use Stale to ensure that conversations here remain relevant. This is for us, the maintainers, so that we don't feel like we've got hundreds of issues to deal with; if you still have an issue, please let us know! We don't want to close issues that are painful for you. Stale just helps us have a bit more breathing space by making sure issues don't pile up forever. -If you're concerned about our bots or feel that they are insensitive in some way, please let us know. +If you're concerned about our apps or feel that they are insensitive in some way, please let us know. From 5bad962d28aedfc3a9dc56bcc7fc8c1aa62b189d Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Thu, 31 May 2018 10:06:30 -0400 Subject: [PATCH 06/10] docs: update links --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c57e1a6..68d2dc0 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ We also use this website to show off some of the cool probot plugins built by th ## Install and Usage -If you'd like to work on this repository, clone it. We use [Jekyll](https://jekyllrb.com/) to build the website, hosted on [GitHub Pages](https://pages.github.com/). We also use Git submodules to pull docs from [probot/docs](http://github.com/probot/docs). +If you'd like to work on this repository, clone it. We use [Jekyll](https://jekyllrb.com/) to build the website, hosted on [GitHub Pages](https://pages.github.com/). We also use Git submodules to pull docs from the docs folder in [probot/probot](https://github.com/probot/probot/tree/master/docs). Once you've cloned this repo, run these commands in this directory: @@ -33,7 +33,7 @@ We'd love to have you contribute! PRs are gladly accepted, and issues are also g If you're interested in contributing, check out our [contributing docs](CONTRIBUTING.md) to get started. -Want to chat with Probot users and contributors? [Join us in Slack](https://probot-slackin.herokuapp.com/)! +Want to get more involved with the Probot community? [Take a look at our community page](https://probot.github.io/community/)! ## License From b2651fc26a01950ac2f1a5146b7c6024d398c43a Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Fri, 8 Jun 2018 11:01:43 +0200 Subject: [PATCH 07/10] docs: small fixes --- CONTRIBUTING.md | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ff49bde..e2bff4a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,7 +9,7 @@ Hi there! We're thrilled that you'd like to contribute to this project. Your hel Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms. -Want to chat with Probot users and contributors? [Join us in Slack](https://probot-slackin.herokuapp.com/)! +Want to get more involved with the Probot community? [Take a look at our community page](https://probot.github.io/community/)! ## Issues diff --git a/README.md b/README.md index 68d2dc0..ed22102 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ 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/serve +script/server ``` 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! From 6fbca294bd389841e74856378b9eeba5bdf4b9dc Mon Sep 17 00:00:00 2001 From: Tommy Byrd Date: Fri, 8 Jun 2018 11:28:41 -0400 Subject: [PATCH 08/10] add language to yaml code block get some of that sweet syntax highlighting to make this easier to read --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e2bff4a..bff5b4e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -49,7 +49,7 @@ Work in Progress pull request are also welcome to get feedback early on, or if t You can add your app to the [website](https://probot.github.io/apps/) by creating a [new file in `_apps/`](https://github.com/probot/probot.github.io/new/master/_apps?filename=your-app-name.md) with this template: -``` +```yaml --- # A human-friendly name of your listing title: Title of Your app From 4a5703b4ce7d5265b9e247c283b3e9cb4b99ef43 Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Mon, 11 Jun 2018 16:43:02 +0200 Subject: [PATCH 09/10] small fixes based on review --- CONTRIBUTING.md | 2 +- README.md | 11 +++++++---- script/bootstrap | 2 +- 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e2bff4a..718f9fe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,7 +17,7 @@ We'd love you to open issues, if they're relevant to this repository: feature re In particular, if you have a large PR you want to send our way, it may make sense to open an issue to discuss it with the maintainers first. -We also use the label 'help wanted' to show issues we want help on! If you'd like to get started working in this repository, it'd be best to jump into those issues. +We also use the label 'help wanted' to show issues we want help on! If you'd like to get started working in this repository, it'd be best to jump into those issues. View those issues [here](https://github.com/probot/probot.github.io/labels/help%20wanted)! ## Submitting a pull request diff --git a/README.md b/README.md index ed22102..b9a0349 100644 --- a/README.md +++ b/README.md @@ -18,14 +18,17 @@ Once you've cloned this repo, run these commands in this directory: ```sh # Only needed the first time: -script/bootstrap +$ script/bootstrap # And each time you work locally: -script/server +$ 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 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! +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 `script`. Go take a look. +Another note: You can see more commands we use, such as our native build and server functions, in the [`script`](https://github.com/probot/probot.github.io/tree/master/script) folder. Go take a look! ## Contribute diff --git a/script/bootstrap b/script/bootstrap index 01dbd7b..98076ea 100755 --- a/script/bootstrap +++ b/script/bootstrap @@ -4,7 +4,7 @@ set -e export CC=gcc echo "==> Installing gem dependencies…" -gem install bundle +which bundle || gem install bundle bundle check --path vendor/gems 2>&1 > /dev/null || { time bundle install --binstubs bin --path vendor/gems } From 130237775bbb3835d3bb75af465a6dd632f93c48 Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Mon, 11 Jun 2018 16:43:20 +0200 Subject: [PATCH 10/10] docs: remove licensee for now --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b9a0349..33c522c 100644 --- a/README.md +++ b/README.md @@ -40,4 +40,4 @@ Want to get more involved with the Probot community? [Take a look at our communi ## License -This website is licensed [CC-BY-4.0](LICENSE) © 2018 Brandon Keepers. The Probot logo is licensed [CC-BY-SA-4.0](https://creativecommons.org/licenses/by-sa/4.0/deed.en). It was found on [wikimedia.org](https://commons.wikimedia.org/wiki/File:Robot-clip-art-book-covers-feJCV3-clipart.png) and is from clipartkid.com. +This website is licensed [CC-BY-4.0](LICENSE). The Probot logo is licensed [CC-BY-SA-4.0](https://creativecommons.org/licenses/by-sa/4.0/deed.en). It was found on [wikimedia.org](https://commons.wikimedia.org/wiki/File:Robot-clip-art-book-covers-feJCV3-clipart.png) and is from clipartkid.com.