app icon indicating copy to clipboard operation
app copied to clipboard

Explain how to install the app

Open jms1voalte opened this issue 2 years ago • 7 comments

Problem Description

  • In this repo's README.md file, under "Usage", item 1 is "Install the app", with a link to https://github.com/apps/settings

  • On that page, under "Usage", is the same item 1, with the same link to https://github.com/apps/settings ... clicking that link looking for directions on how to install the app just takes you to the same page you're already on.

If there is a separate page explaining how to install the app, shouldn't these links point there instead of just pointing to the same page over and over again?

What is actually happening

Links point to the same page that the link itself is on, without any details about how to "install" the app.

What is the expected behavior

Links should point to a page which explains how to "install" the app.

jms1voalte avatar Apr 14 '22 18:04 jms1voalte

I think that Installing GitHub Apps is what you are after

electriquo avatar Apr 20 '22 15:04 electriquo

That's possible ... and if so, why doesn't the README.md file contain a link to THAT page? Having a link that says "Install the app", WHICH POINTS TO THE SAME PAGE, is rather pointless, no?

jms1voalte avatar Apr 20 '22 15:04 jms1voalte

The ProBot Settings app on GitHub Apps is using the README.md of the project. You should look at the green button on the right side that says "install".

electriquo avatar Apr 20 '22 15:04 electriquo

There is no green button that says "install" if you're not logged into a GitHub account.

image

In my case, I'm using Safari in "private mode", which means that the session cookies which make me "logged in" on one tab, don't carry over to new tabs. Once I logged in in the second tab I was able to see big green button, and things started to make sense.

So maybe it would make sense to add something which tells the user to log into their account if they don't see the big green button? (And included the link you provided, to a "how to install GitHub Apps in general" page, as well. That would be helpful to people like me for whom this is their first exposure to GitHub Apps.)

jms1voalte avatar Apr 20 '22 16:04 jms1voalte

@jms1voalte You are not signed-in to GitHub. Once you do, the green "install" button will appear.

electriquo avatar Apr 20 '22 17:04 electriquo

@foolioo Agreed. @jms1voalte you should probably not expect to be finding a tailored install flow for an extension when you're not logged in. This feels quite niche, as the vast majority of people travelling this path will be logged in.

Having said that, speaking as a passerby here, I'm sure if you felt like submitting a small change to the repo to tip off someone like yourself in the future, the future person like yourself would be appreciative ❤️

patcon avatar Apr 24 '22 20:04 patcon

Actually, just added it here, since it seems it's such a small fix that would make it clearer 🙏 https://github.com/probot/settings/pull/573

patcon avatar Apr 24 '22 20:04 patcon