Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Let's talk about description #20

Closed
bhousel opened this issue Mar 14, 2018 · 1 comment
Closed

Let's talk about description #20

bhousel opened this issue Mar 14, 2018 · 1 comment
Labels
question Further information is requested

Comments

@bhousel
Copy link
Member

bhousel commented Mar 14, 2018

The example community resource has this:

{
  "id": "OSM-US-Slack",
  "name": "OpenStreetMap US Slack",
  "description": "Sign up at {url}",
  "url": "https://osmus-slack.herokuapp.com/",
  ...
}

That description is not great. It's really just a placeholder.
Using my iD mockup below for inspiration - what kinds of things do we want to include in a description?

  • How long is reasonable? A few lines?
  • Formatting? We could do markdown, but I'd rather not.
  • I put that {url} token in there, thinking we might replace it with the real url, but then we also need url text. Thinking about it more, I'd prefer not to do token replacements unless we have a compelling reason.
  • That url link goes to the auto-inviter, not to the actual url which is https://osmus.slack.com - is that weird? (maybe need separate signup and visit links?)
  • Should we add another field for a more extended description, maybe more suited for an expandable block of text, like these "details" things:
    lots of good stuff in here

screenshot 2018-03-13 12 57 45

@bhousel bhousel added the question Further information is requested label Mar 14, 2018
@bhousel bhousel mentioned this issue Mar 14, 2018
@althio
Copy link

althio commented Mar 18, 2018

How long is reasonable? A few lines?
Should we add another field for a more extended description, maybe more suited for an expandable block of text, like these "details" things

I would like a short description (1 line) and a extended description (expandable block)

<< Formatting? We could do markdown, but I'd rather not.

Maybe formatting is overkill for a description. Or keep that for another later issue.

That url link goes to the auto-inviter, not to the actual url which is https://osmus.slack.com - is that weird? (maybe need separate signup and visit links?)

Yes to separate links signup/visit.

bhousel added a commit that referenced this issue Mar 21, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants