Add links to instructions inside admin

(JohnONolan) #1

Hey team! Recently set up a discourse install and noticed one potential area for an easy enhancement.

When you go through Discourse settings, there are a whole bunch of fields for doing things, and none of them have descriptions (or, sometimes, names that you can even figure out). This is a little intimidating.

What I found myself doing was

  1. Explore Discourse settings
  2. Notice google_oauth field to enable login with google
  3. Grumble at lack of instructions, start searching google for howto get an OAuth2 api key or whatever
  4. Grumble some more when that didnt work
  5. Eventually discover meta.discourse topic with perfect instructions (including the need to manually enable a totally unrelated google+ API in a totally different area of google’s settings, WTF)

After that, I just searched meta.discourse every single time I was going to set something up and found really fantastic docs on how to do all of it.

So anyway here’s my suggestion: Add a ? icon/link beside settings fields labels which have respective topics on :slight_smile: would make initial setup a lot more pleasurable!


Same experience here while trying to activate oAuth2 with Google.

+1 for this suggestion.

(Felix Freiberger) #3

I really like this idea. :+1:
It might even be more feasible then it appears at first sight: We don’t need a topic for every single setting. Instead, for example, just linking all SSO-related settings to here would already be hugely helpful!

(Joshua Rosenfeld) #4

It’s been on my list to do a full review of site settings and their descriptions. Given the number of settings we have that will take a long time.

However, when I have specific, easily actionable feedback like this I can fix it much more quickly. I don’t see adding a ? to site settings - that would require some engineering work - but adding links to descriptions is easy enough.

(Jay Pfaffman) #5

This is probably a good idea for all of the social logins.

(Sam Saffron) #6

One possible dev related change we may need is to support hyperlinks in field descriptions. While you perform the review we have to also confirm or build support do <a href='abc'>something awesome</a> as a site setting description.

(Joshua Rosenfeld) #7

Pretty sure we support that already - I believe I updated something inside a <a href= block before. Will confirm.

Edit: Yep, we support it already. See the s3 use iam profile site setting: