Improve the doc about ckan.featured_groups

[formwandler]

The parameter ckan.featured_groups should be better documented.

My history: I have configured the "title" of the group, e.g. "Group1" or "MySpecialGroup", which did not work. I had to change it to the URL names, which in my case could be e.g. "group1" (case sensitive!) and "my-special" (URL name customized/shortened).

*You need to use the URL name
*The values are case sensitive

[seanh]

I'm not sure this issues is specific to ckan.featured_groups. Throughout CKAN, datasets, groups, organizations, users, etc. have both unique names and "titles" that are display versions of the names. In many places in the CKAN config file and in the API etc. you have to use the names or IDs but not the titles.

[formwandler]

About title vs. names: But in the groups section of the GUI there is just a "Title:" field and the "URL:" field. No "name" or "id" like mentioned in the docs. So, this should be more precise (e.g. the name is part of the URL). But where is the id (maybe from the database?)?

[tobes]

@formwandler in ckan we can identify a dataset via it's name or id only as these are unique. The title could be the same across many datasets (though this is unlikely/unhelpful)

Maybe the id/name should be more visible in the front-end

[seanh]

Yeah, I'm just wondering where this should go in the docs. See the current table of contents here: http://docs.ckan.org/en/latest/. Maybe we should insert a Domain Model page somewhere in the docs, that goes over the main objects in CKAN (package, resource, group, organization, user...) and explains what they are and what fields they have?

[seanh]

Closing due to inactivity. I would like to see the docs improvements mentioned, though