Add rtd-bot to the list #243

KengoTODA · 2018-09-05T01:20:34Z

Thanks for making so interesting probot platform! Here I want to add one more app in the list.

Checklist

hiimbex

Love this app! Great use case. Do you think instead of making it's own comment, it might be nice for the bot to edit the original pull request body at the very bottom and add the link there? (we had a similar idea for making links to rendered markdown files that were changed in a PR)

Ensure all fields in the pull request template have been checked and links are included.
Verify the legitimacy of each link.
Open each of the screenshots to ensure they show the specific app functionality as clearly as possible.
Install the app on a test organization and ensure the app works as advertised.
Confirm the app slug is associated with the app.
Think about the app's usecase and usefulness to developers. This often becomes a discussion amongst the maintainers in private channels if there's concerns that the app doesn't provide tangible benefits.
Read the entire description/how the app works to make sure someone new could figure it out.

I'll be honest, I've never used Read the Docs before, so it was sort of difficult for me to figure out how this app worked and what it's requirements were. Do you think you could update the description to explain a little better?

_apps/rtd-bot.md

hiimbex · 2018-09-05T01:27:34Z

_apps/rtd-bot.md

+# 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


Any chance you'd consider renaming to a slug with bot in it? The GitHub UI already displays [bot] next to every GitHub App.

It seems that rtd is already in use. And I don't want to use Read The Docs that may be used by official one in future (they use this name for GitHub Services).

Is it OK to keep this name?

_apps/rtd-bot.md

KengoTODA · 2018-09-05T03:25:07Z

it might be nice for the bot to edit the original pull request body at the very bottom and add the link there?

I've added this idea to my ROADMAP:
KengoTODA/readthedocs-action@dbe6d0a

BTW about the CI build failure, it seems that it's not related with my changes. Plz check it.

KengoTODA · 2018-09-05T03:48:24Z

Do you think you could update the description to explain a little better?

I'll handle this later.

KengoTODA · 2018-09-10T03:26:02Z

it might be nice for the bot to edit the original pull request body at the very bottom and add the link there?

This feature has been implemented, see the updated screen shot.

KengoTODA · 2018-09-10T03:30:28Z

Do you think you could update the description to explain a little better?

I've improved description.

I've finished all known TODOs, please review again later. Thanks in advance!

hiimbex · 2018-09-19T04:14:57Z

_apps/rtd-bot.md

+# 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


We banned the word bot from being included in slugs since when your app is displayed on GitHub, it is shown next to [bot]. Would you consider renaming your app?

OK I've renamed my app, and updated slug in this .md file.

hiimbex · 2018-09-19T04:18:01Z

_apps/rtd-bot.md

+
+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:


then you'll find that PR for documentation needs additional steps like:

Where does this documentation live?

In Github repo, we have it in docs directory. In Read the Docs, it exists under specific domain like https://${PROJECT_NAME}.readthedocs.io/${LANG}/${BRANCH_NAME}/

Yes, but my question is, how would a user figure that out just from your comment there? I was not able to figure it out :(

Do you mean how user can find the URL of generated document? If so, it'll be injected into PR body like this:

https://raw.githubusercontent.com/KengoTODA/rtd-bot/master/screenshot.png

probot/probot.github.io#243 (comment)

stale · 2018-12-24T06:05:03Z

Is this still relevant? If so, what is blocking it? Is there anything you can do to help move it forward?

KengoTODA · 2018-12-24T06:23:01Z

Hi @Stale! I'm waiting reaction from @hiimbex and believe that we can keep this issue open :)

KengoTODA · 2019-04-08T06:27:44Z

Hi @hiimbex, could you review this change? :)

I believe that the failure of CI isn't related with my changes.

stale · 2019-07-07T06:29:46Z

Is this still relevant? If so, what is blocking it? Is there anything you can do to help move it forward?

KengoTODA · 2019-07-08T02:12:18Z

Hi @hiimbex could you check this PR? Thank you :)

stale · 2019-10-06T02:57:19Z

Is this still relevant? If so, what is blocking it? Is there anything you can do to help move it forward?

KengoTODA · 2019-10-09T01:01:52Z

Hi @hiimbex @bkeepers @JasonEtco could you check this PR? Thank you :)

gr2m · 2019-10-09T03:14:03Z

Sorry we didn't get back to you yet, we are currently unsure how to proceed with the apps gallery. You can submit your app to the marketplace which accepts unverified apps now. We'd still like to highlight apps created with Probot but are unsure how right now

stale · 2020-01-07T04:30:37Z

Is this still relevant? If so, what is blocking it? Is there anything you can do to help move it forward?

gr2m · 2020-01-07T15:07:01Z

We'll merge submissions for now, as long as the apps look useful :)

KengoTODA · 2020-01-08T00:38:38Z

Thank you!

KengoTODA requested review from bkeepers, hiimbex and JasonEtco as code owners September 5, 2018 01:20

hiimbex suggested changes Sep 5, 2018

View reviewed changes

KengoTODA added a commit to KengoTODA/readthedocs-action that referenced this pull request Sep 5, 2018

docs(ROADMAP.md): Add suggested feature at probot/probot.github.io#243

dbe6d0a

KengoTODA added a commit to KengoTODA/readthedocs-action that referenced this pull request Sep 5, 2018

docs(ROADMAP.md): Add suggested feature at probot/probot.github.io#243

e2ee3a5

hiimbex reviewed Sep 19, 2018

View reviewed changes

KengoTODA added a commit to KengoTODA/readthedocs-action that referenced this pull request Sep 20, 2018

docs: rename Probot to follow their naming policy

30fae06

probot/probot.github.io#243 (comment)

KengoTODA mentioned this pull request Sep 20, 2018

Rename Probot to follow their naming policy KengoTODA/readthedocs-action#30

Merged

KengoTODA added a commit to KengoTODA/readthedocs-action that referenced this pull request Sep 20, 2018

docs: rename Probot to follow their naming policy

d02c86b

probot/probot.github.io#243 (comment)

stale bot added the wontfix label Dec 24, 2018

stale bot removed the wontfix label Dec 24, 2018

JasonEtco added the new app label Jan 21, 2019

stale bot added the wontfix label Jul 7, 2019

stale bot removed the wontfix label Jul 8, 2019

stale bot added the wontfix label Oct 6, 2019

stale bot removed the wontfix label Oct 9, 2019

stale bot added the wontfix label Jan 7, 2020

KengoTODA added 6 commits January 7, 2020 06:55

add a site for rtd-bot

e17bef2

remove needless trailing slash

5d0ec9b

make description more user friendly

b91ad49

improve explanation for human with example scenario

53afaea

rename probot slug to follow naming rule

f79558b

improve title and description to make them intuitive

e027b18

gr2m force-pushed the rtd-bot branch from 2cb537a to e027b18 Compare January 7, 2020 14:55

stale bot removed the wontfix label Jan 7, 2020

gr2m merged commit 06ebf54 into probot:master Jan 7, 2020

KengoTODA deleted the rtd-bot branch January 8, 2020 00:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add rtd-bot to the list #243

Add rtd-bot to the list #243

KengoTODA commented Sep 5, 2018

hiimbex left a comment

hiimbex Sep 5, 2018

KengoTODA Sep 5, 2018

KengoTODA commented Sep 5, 2018

KengoTODA commented Sep 5, 2018

KengoTODA commented Sep 10, 2018

KengoTODA commented Sep 10, 2018

hiimbex Sep 19, 2018

KengoTODA Sep 20, 2018

hiimbex Sep 19, 2018

KengoTODA Sep 19, 2018

hiimbex Sep 24, 2018

KengoTODA Sep 25, 2018

stale bot commented Dec 24, 2018

KengoTODA commented Dec 24, 2018

KengoTODA commented Apr 8, 2019

stale bot commented Jul 7, 2019

KengoTODA commented Jul 8, 2019

stale bot commented Oct 6, 2019

KengoTODA commented Oct 9, 2019

gr2m commented Oct 9, 2019

stale bot commented Jan 7, 2020

gr2m commented Jan 7, 2020

KengoTODA commented Jan 8, 2020


		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:

Add rtd-bot to the list #243

Add rtd-bot to the list #243

Conversation

KengoTODA commented Sep 5, 2018

Checklist

hiimbex left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KengoTODA commented Sep 5, 2018

KengoTODA commented Sep 5, 2018

KengoTODA commented Sep 10, 2018

KengoTODA commented Sep 10, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stale bot commented Dec 24, 2018

KengoTODA commented Dec 24, 2018

KengoTODA commented Apr 8, 2019

stale bot commented Jul 7, 2019

KengoTODA commented Jul 8, 2019

stale bot commented Oct 6, 2019

KengoTODA commented Oct 9, 2019

gr2m commented Oct 9, 2019

stale bot commented Jan 7, 2020

gr2m commented Jan 7, 2020

KengoTODA commented Jan 8, 2020