From e17bef22b58075013bda3768349dbb92bf2b2704 Mon Sep 17 00:00:00 2001 From: Kengo TODA Date: Tue, 4 Sep 2018 18:03:37 +0800 Subject: [PATCH 1/6] add a site for rtd-bot --- _apps/rtd-bot.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 _apps/rtd-bot.md diff --git a/_apps/rtd-bot.md b/_apps/rtd-bot.md new file mode 100644 index 00000000000..d6ccaaa0beb --- /dev/null +++ b/_apps/rtd-bot.md @@ -0,0 +1,20 @@ +--- +# A human-friendly name of your listing +title: Read The Docs +# A short description of what your app does +description: An unofficial GitHub Probot that helps reveiwing on Read The Docs +# The slug of your hosted app on GitHub (https://github.com/apps/YOUR-SLUG) +slug: rtd-bot +# Include a few screenshots that show your app in action +screenshots: +- https://raw.githubusercontent.com/KengoTODA/rtd-bot/master/screenshot.png +# The GitHub usernames of anyone who authored the app +authors: +- KengoTODA +# The repository where the code is located +repository: KengoTODA/rtd-bot +# The address where this app is deployed +host: https://rtd-bot.herokuapp.com/ +--- + +Get URL of documents when review changes in docs directory. From 5d0ec9b8776819461578075e9a67f78cbe36e67d Mon Sep 17 00:00:00 2001 From: Kengo TODA Date: Wed, 5 Sep 2018 10:13:31 +0800 Subject: [PATCH 2/6] remove needless trailing slash --- _apps/rtd-bot.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_apps/rtd-bot.md b/_apps/rtd-bot.md index d6ccaaa0beb..0b67a1c2c18 100644 --- a/_apps/rtd-bot.md +++ b/_apps/rtd-bot.md @@ -14,7 +14,7 @@ authors: # The repository where the code is located repository: KengoTODA/rtd-bot # The address where this app is deployed -host: https://rtd-bot.herokuapp.com/ +host: https://rtd-bot.herokuapp.com --- Get URL of documents when review changes in docs directory. From b91ad4989be953791adec9f41c750bee754ca23d Mon Sep 17 00:00:00 2001 From: Kengo TODA Date: Wed, 5 Sep 2018 10:14:17 +0800 Subject: [PATCH 3/6] make description more user friendly --- _apps/rtd-bot.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_apps/rtd-bot.md b/_apps/rtd-bot.md index 0b67a1c2c18..43587e0ebfc 100644 --- a/_apps/rtd-bot.md +++ b/_apps/rtd-bot.md @@ -2,7 +2,7 @@ # A human-friendly name of your listing title: Read The Docs # A short description of what your app does -description: An unofficial GitHub Probot that helps reveiwing on Read The Docs +description: Assists reviewing using Read The Docs # The slug of your hosted app on GitHub (https://github.com/apps/YOUR-SLUG) slug: rtd-bot # Include a few screenshots that show your app in action From 53afaea95474e8f6b8d534894a900c883355ab15 Mon Sep 17 00:00:00 2001 From: Kengo TODA Date: Mon, 10 Sep 2018 11:29:45 +0800 Subject: [PATCH 4/6] improve explanation for human with example scenario --- _apps/rtd-bot.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/_apps/rtd-bot.md b/_apps/rtd-bot.md index 43587e0ebfc..0daea96b8f1 100644 --- a/_apps/rtd-bot.md +++ b/_apps/rtd-bot.md @@ -18,3 +18,10 @@ host: https://rtd-bot.herokuapp.com --- Get URL of documents when review changes in docs directory. + +Work with Read The Docs, then you'll find that PR for documentation needs additional steps like: + +* running RTD build for your branch manually, to use its result as staging site [like this](https://github.com/spotbugs/spotbugs/pull/697#issue-201455071), or +* sharing screenshot to share the updated document [like this](https://github.com/spotbugs/spotbugs/pull/718#issue-205904835). + +This bot automates the first approach; activate RTD build automatically when you made PR that updates `docs/` directory. From f79558b7606f6880b327ff555f8f32ac1077c715 Mon Sep 17 00:00:00 2001 From: Kengo TODA Date: Thu, 20 Sep 2018 13:17:44 +0800 Subject: [PATCH 5/6] rename probot slug to follow naming rule --- _apps/{rtd-bot.md => rtd-helper.md} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename _apps/{rtd-bot.md => rtd-helper.md} (98%) diff --git a/_apps/rtd-bot.md b/_apps/rtd-helper.md similarity index 98% rename from _apps/rtd-bot.md rename to _apps/rtd-helper.md index 0daea96b8f1..8d4d07856fb 100644 --- a/_apps/rtd-bot.md +++ b/_apps/rtd-helper.md @@ -4,7 +4,7 @@ title: Read The Docs # A short description of what your app does description: Assists reviewing using Read The Docs # The slug of your hosted app on GitHub (https://github.com/apps/YOUR-SLUG) -slug: rtd-bot +slug: rtd-helper # Include a few screenshots that show your app in action screenshots: - https://raw.githubusercontent.com/KengoTODA/rtd-bot/master/screenshot.png From e027b1896f396c85f62d7d3c10884177dfb496b7 Mon Sep 17 00:00:00 2001 From: Kengo TODA Date: Fri, 1 Feb 2019 11:26:19 +0800 Subject: [PATCH 6/6] improve title and description to make them intuitive --- _apps/rtd-helper.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_apps/rtd-helper.md b/_apps/rtd-helper.md index 8d4d07856fb..ad9c157e55a 100644 --- a/_apps/rtd-helper.md +++ b/_apps/rtd-helper.md @@ -1,8 +1,8 @@ --- # A human-friendly name of your listing -title: Read The Docs +title: Read The Docs Helper # A short description of what your app does -description: Assists reviewing using Read The Docs +description: Assists reviewing using Read The Docs (RTD) # The slug of your hosted app on GitHub (https://github.com/apps/YOUR-SLUG) slug: rtd-helper # Include a few screenshots that show your app in action