[core] Support for bridge maintainers' donation URLs #2102

Bockiii · 2021-05-04T12:54:52Z

Contribution to #2099

This adds a new const "DONATION_URL" to the bridges. If set, a new (green for better distinguishing) button will be shown on the HTML overview, linking to that URL.

Bockiii · 2021-05-04T13:00:10Z

If you want to test this, just add something like this to your bridge:

const MAINTAINER = 'Me';
const NAME = 'My Bridge';
const URI = 'https://www.google.com';
const DONATION_URI = 'https://github.com/em92/rss-bridge/blob/donation/doc/donate/em92.md';
const CACHE_TIMEOUT = 21600; // 6h
const DESCRIPTION = 'Yay, google.';

em92 · 2021-05-04T20:04:57Z

Not sure about design.

@ORelio and @JackNUMBER hi! Any suggestions about that link?

Also ping @somini @VerifiedJoseph @sysadminstory @corenting @AntoineTurmel @teromene @mitsukarenai @logmanoriginal. If you haven't read discussion about donation, you can read it here #2063

em92 · 2021-05-04T20:05:32Z

Forgot to ping @Roliga

Bockiii · 2021-05-04T21:29:19Z

I'm pretty sure that is your browser.
Firefox:

Chrome:

Edge:

It doesn't matter how large or small I make the window, the button doesn't morph like in your screenshot

Bockiii · 2021-05-04T21:30:54Z

About the colors: I'm not the best person for color choices, so feel free to change those :) My idea was to use a darker green for the link and a lighter green for the hover. If you have better values, go for it. I just wanted to use a positive color so the user notices it.

JackNUMBER · 2021-05-04T22:59:51Z

Thank you @Bockiii for initiating the design update.
About the

I suggest this color, as a tribute to the old logo ;)

Or something less "eye catchy". This way the buttons are limited to the output format.

JackNUMBER · 2021-05-04T23:03:15Z

About the 2-lines-button issue :

Fix 1

It can be fixed with min-height: 40px, reduce Y's paddings and remove line-height.
<- desktop
<- mobile

Fix 2

In an other hand, if we want to keep the same design everywhere we can apply white-space: nowrap, min-width: 200px and remove line-height but it can bring side effects on mobile.
<- desktop
<- mobile

Bockiii · 2021-05-04T23:15:25Z

Thank you @Bockiii for initiating the design update.

No problem :)

I suggest this color, as a tribute to the old logo ;)

That color is also fine with me. If you have an idea for the lighter "hover" color, post the values and I can change them

Or something less "eye catchy". This way the buttons are limited to the output format.

I actually want it to be catchy. If the maintainer doesnt provide the URL, it isn't shown at all, so it will only be shown on bridges with donation info. That way, people will actually notice the option and can then still choose to ignore it.
The eye-catchiness was the main reason I added it as an additional button in the location that everyone looks at anyways.

Bockiii · 2021-05-04T23:17:54Z

@JackNUMBER I like Fix 1 better than Fix 2.

Also, "Fix 3" could be just to write "Donate" on the button and not have the issue at all :D

I just wanted to make clear that you donate to the bridge maintainer and not to rss-bridge in general (we could/should put a button for that somewhere as well btw)

JackNUMBER · 2021-05-04T23:25:15Z

@Bockiii

I actually want it to be catchy. If the maintainer doesnt provide the URL, it isn't shown at all, so it will only be shown on bridges with donation info. That way, people will actually notice the option and can then still choose to ignore it.
The eye-catchiness was the main reason I added it as an additional button in the location that everyone looks at anyways.

Agreed!
Default: #ff6600
Hover: #ff8a3b

I just wanted to make clear that you donate to the bridge maintainer and not to rss-bridge in general (we could/should put a button for that somewhere as well btw)

Agreed too! That's why I keep the complete label you did :)

Bockiii · 2021-05-04T23:29:15Z

donezo

JackNUMBER

More code style comments than functional 😄

formats/HtmlFormat.php

static/HtmlFormat.css

lib/FormatAbstract.php

actions/ListAction.php

actions/DisplayAction.php

Bockiii · 2021-05-05T07:59:21Z

Woops. didnt mean to start the review :D You can close that.

I added a new commit, doing all the style changes from @JackNUMBER

actions/DisplayAction.php

Bockiii · 2021-05-05T09:52:17Z

@em92 Do you want to add a donate button to rss-reader as well?

I would suggest doing it next to the hide-inactive-button. This way it's out of sight usually but still visible enough to not completely overlook. I would do it in the same visual style as the maintainer donate buttons, just smaller to fit the hide-inactive button.

Thoughts?

Also, do we want to make this configurable? So add a setting to not show donation buttons at all? I'm 80% "no" on this, but maybe someone else has a good point to make.

teromene · 2021-05-05T09:58:58Z

The design looks fine to me, and I think that the idea of allowing donations for bridge maintainers is a great idea as well.

JackNUMBER · 2021-05-05T12:20:12Z

Can I suggest something like that?

Bockiii · 2021-05-05T13:42:59Z

I am more on the side of "Make it visible on every specific bridge and less visible on the front page". So my vote is against the small donate link.

You can inline-review and add changes btw @JackNUMBER . If you change the .css to the 2-line-fix1, I can accept them here in this PR.

somini · 2021-05-06T14:14:44Z

I like this, and would propose combining this with a project-wide banner on top asking for donations. Sort of like Wikipedia?

Bockiii · 2021-05-06T14:18:58Z

Isn't that one of the most universally hated banners in the web?

I'm still pro-button, but if you want to go with the text link, I would definitely not do a banner.

I'll just say that this will be overlooked completely.

Bockiii · 2021-05-06T17:21:16Z

Should we run a public poll for the different solutions or wo wants to decide this? I can code the solution, I just need to know the "what" :D

em92 · 2021-05-06T18:10:42Z

@Bockiii, I think we need to have both "clearly visible button in html preview" and "small text link in bridge card" and option, where instance admin chooses one (or even none, if admin does not want to show them). The default one should be "clearly visible button", 'cos of strategy to promote donation.

would propose combining this with a project-wide banner on top asking for donations. Sort of like Wikipedia?

@somini , that is discussable, but not here.

em92 · 2021-05-06T18:13:09Z

Do you want to add a donate button to rss-reader as well?

If you mean add donation link to feed items, then no. That is definitely going to be frustrating for users.

Bockiii · 2021-05-06T18:21:48Z

I meant a "donate to rss-bridge" link somewhere. One option would be next to the "show inactive" button. At the end of the site and usually half-greyed out if you dont hover over it. As I user, i would be find with it being there.

So I will do this:

One button like it is now on the html overview
One link on the bridgecard like in sominis screenshot
Global opt-out to not display donation links at all. Placed in the config.ini

I would not do it opt-in since we want to promote the usage. In the future, we could switch the default in the config ini to opt-in.

Bockiii · 2021-05-06T19:57:49Z

Current state:

Config option to disable donations. Default is "true" for donation display
Bridge Maintainer Donations as button in HTML and as link in bridgelist view
RSS-Bridge general donation link (I need an actual link to point to @em92 as I couldn't find anything) in the footer of the page.

html view:

bridgelist view:

general rss-bridge dono:

Thoughts?

ORelio · 2021-05-06T21:08:32Z

Thoughts?

Hi, just read all the discussion and I totally agree with this end result. With donate link not too agressive in bridge list, more visible button in bridge details, and setting to optionally disable the feature 👍

ORelio · 2021-05-06T21:14:45Z

However I'm not super confident in the financial part of the feature: what happens if several people work on a bridge? How to split/manage donations for the project-wide donation link? I'm not planning to accept donations for my own bridges in the near future but I'm still curious 🤔

Bockiii · 2021-05-06T21:48:17Z

for the general: no idea.

For the maintainer: I think the majority of bridges have 1 maintainer. If its more than one, I assume the team has to decide if the "old" maintainer is still worthy enough.

We could also do a mandatory site in the repo were we list a kind-of-history. "Originally by Peter, maintained by Paul since 2018. Link for Peter <> Link for Paul <>" or something... idk. I just picked up the todo, I have no game in this fight

somini · 2021-05-07T14:49:46Z

Thoughts?

LGTM.

Bockiii · 2021-05-11T21:48:59Z

it's been 4 days. Anyone still thinking about anything?

Bockiii · 2021-05-11T21:57:31Z

Ah, I see that the discussion in the discussions post is still going. All good then.

teromene · 2021-06-08T13:05:51Z

Any blocker once PHPCS problems are fixed ? @em92

Bockiii · 2021-06-08T17:17:23Z

@em92 @teromene all fixes fixed.

em92 · 2021-06-12T17:53:58Z

lib/BridgeList.php

@@ -178,10 +179,14 @@ private static function getFooter($totalBridges, $totalActiveBridges, $showInact

 		}

+		if($donationsAllowed) {
+			$donation = ' ~ <a href="http://www.google.com">Donate</a>';


Wnat is expected here?

Ah, thats right. Thats the rss-bridge-general-donation-url, so not bridge specific but for rss-bridge itself. You need to define that link

Bockiii · 2021-06-20T13:32:51Z

Okay. If you ever want to add a general dono URL, you have an example.

Other than that, we would also need to adapt documentation. How far along is the rework?

em92 · 2021-06-25T19:44:25Z

Other than that, we would also need to adapt documentation. How far along is the rework?

Mark Ruffallo and Leonardo Di Caprio meme

em92 · 2021-06-25T19:45:28Z

gj @Bockiii !

Bockiii mentioned this pull request May 4, 2021

TODOs #2099

Closed

9 tasks

JackNUMBER reviewed May 5, 2021

View reviewed changes

Bockiii commented May 5, 2021

View reviewed changes

actions/DisplayAction.php Outdated Show resolved Hide resolved

em92 changed the title ~~[Core] Support for donation URLs~~ [core] Support for bridge maintainers' donation URLs May 6, 2021

[Core] Support for donation URLs

c1c2a30

Bockiii force-pushed the donationsupport branch from 4b812b3 to c1c2a30 Compare May 11, 2021 21:49

Bockiii added 3 commits June 8, 2021 19:06

phpcs fixes

0bea5e2

More phpcs fixes

a5e5003

moar fixes

e92eb8c

em92 reviewed Jun 12, 2021

View reviewed changes

Remove rss-bridge-general-donation-url

ce2fc1d

em92 merged commit ecaae73 into RSS-Bridge:master Jun 25, 2021

[core] Support for bridge maintainers' donation URLs #2102

[core] Support for bridge maintainers' donation URLs #2102

Conversation

Bockiii commented May 4, 2021

Bockiii commented May 4, 2021

em92 commented May 4, 2021

em92 commented May 4, 2021

Bockiii commented May 4, 2021

Bockiii commented May 4, 2021

JackNUMBER commented May 4, 2021

JackNUMBER commented May 4, 2021 • edited Loading

Fix 1

Fix 2

Bockiii commented May 4, 2021

Bockiii commented May 4, 2021

JackNUMBER commented May 4, 2021 • edited Loading

Bockiii commented May 4, 2021

JackNUMBER left a comment

Choose a reason for hiding this comment

Bockiii commented May 5, 2021

Bockiii commented May 5, 2021

teromene commented May 5, 2021

JackNUMBER commented May 5, 2021

Bockiii commented May 5, 2021

somini commented May 6, 2021

Bockiii commented May 6, 2021

Bockiii commented May 6, 2021

em92 commented May 6, 2021

em92 commented May 6, 2021

Bockiii commented May 6, 2021

Bockiii commented May 6, 2021

ORelio commented May 6, 2021

ORelio commented May 6, 2021

Bockiii commented May 6, 2021

somini commented May 7, 2021

Bockiii commented May 11, 2021

Bockiii commented May 11, 2021

teromene commented Jun 8, 2021

Bockiii commented Jun 8, 2021

em92 Jun 12, 2021

Choose a reason for hiding this comment

Bockiii Jun 12, 2021

Choose a reason for hiding this comment

Bockiii commented Jun 20, 2021

em92 commented Jun 25, 2021

em92 commented Jun 25, 2021

JackNUMBER commented May 4, 2021 •

edited

Loading

JackNUMBER commented May 4, 2021 •

edited

Loading