Ticket #2347 (closed enhancement: fixed)

Opened 2 years ago

Last modified 22 months ago

Related stuff dashboard and changes

Reported by: ross Owned by: icmurray
Priority: awaiting merge Milestone: ckan-v1.8
Component: ckan Keywords: [6d][r:2d] ui
Cc: aron.carroll Repository: ckan
Theme: none

Description (last modified by ross) (diff)

Some additions to the related stuff functionality to make it more useful post the 1.7 release.

[x] Edit item (after checking auth)

[x] My related things on my user page

[x] Show user created related things on the users' page with links direct to the related page of that dataset. {0.5d}

[x] Related stuff usage counts { 1d }

Record the number of times the link for a related item is clicked. This is likely to mean that the link fires to call CKAN and then redirects to the actual URL.

[x] Un-attached related items {0.25d}

Allow related items to be created without being attached to datasets. This may mean that the dataset field is optional in the API.

[ ] Dashboard for related

A dashboard for related items, site-wide (not package specific) and orderable by date, views, {rating}, popularity of the dataset. Would be useful (possibly) for site-admin to mark one or more as 'featured'

[x] Dashboard + Controller (Related) {1d}

[x] Ordering at logic layer (date, views, rating, popularity of package, featured) {1d}

[x] date [x] views [x] featured

[x] 'Featured' related item with mechanism to fetch it. {0.5d}

[ ] UI within dashboard for sysadmins to check/uncheck feature status {0.5d}

[x] Changing auth for related.

Currently auth is based on deletion being possible by dataset owner and the related owner but it may be that a lot of the auth for related items should be configured to have more restrictive auth.

[x] Implement auth changes for publisher auth profile. { 0.5d }

[x] General issues

[x] Serverside validation of URLs

[x] Activity updates

[x] Make optional

[x] Related item only includes App, Idea, Visualization but not API | Post | Paper | News Article options as in original ticket #2204

[ ] UI Changes

[ ] General tidy up, fix form etc (icon for menu bar)

[ ] Highlight featured items py:if="related.featured"

[ ] Show either view count or popularity ${ related.view_count }

[ ] A user's related items should be on their home page

[ ] Related item plus sign is very poorly aligned within box

[ ] Add related items should be in drop down like for resources (?) to make it easy to add items

[ ] Hover should show a title that gives some information about what related are (not at all clear)

"Apps, Ideas, Visualization and other material related to this dataset"

[x] Related is a pretty terrible name in the UI - much better to have it called Apps, Ideas etc (perhaps title tag could even give more details e.g. "Apps, Ideas, Visualization and other material related to this dataset") -- btw i thought this was in #2332 but realize it wasn't (apologies for that!)

  • Went with Apps & Ideas (for now)

[x] Documentation, documentation, documentation - AFAICT I can't see anything in v1.7 or master docs. I imagine this would be a short section like http://docs.ckan.org/en/ckan-1.7/commenting.html (and probably coming right after that in the ToC) which says

  • What it does
  • How to enable (and perhaps includes a nice-screenshot!)
  • How to customize (e.g. can one customize the list of options of things one can create (e.g. can I set it to just be app and idea or ...)
  • Also liase with Mark W re a blog post about this from the user perspective (a screenshot walkthrough ...)

[ ] Clearly mark the old extension as deprecated from v1.7 forward: https://github.com/okfn/ckanext-apps (I just met someone last week who was working on integrating this and had no idea it was replaced by something better in v1.7)

Change History

comment:1 Changed 2 years ago by ross

  • Keywords [6d] added
  • Description modified (diff)

comment:2 Changed 2 years ago by ross

[ ] Check that dataset privacy can be taken into account.

comment:3 Changed 2 years ago by ross

  • Description modified (diff)

comment:4 Changed 2 years ago by ross

  • Description modified (diff)

comment:5 Changed 2 years ago by ross

  • Description modified (diff)

comment:6 Changed 2 years ago by ross

  • Description modified (diff)

comment:7 Changed 2 years ago by ross

  • Description modified (diff)

comment:8 Changed 2 years ago by ross

  • Cc aron.carroll added
  • Description modified (diff)

Keeping track of UI changes required, and copied Aron

comment:9 Changed 2 years ago by ross

  • Description modified (diff)

comment:10 Changed 2 years ago by ross

  • Description modified (diff)

comment:11 Changed 2 years ago by ross

  • Description modified (diff)

comment:12 Changed 2 years ago by ross

  • Description modified (diff)

comment:13 Changed 2 years ago by ross

  • Description modified (diff)

comment:14 Changed 2 years ago by ross

  • Description modified (diff)

comment:15 Changed 2 years ago by ross

  • Description modified (diff)

comment:16 Changed 2 years ago by ross

  • Description modified (diff)

comment:17 Changed 2 years ago by ross

  • Description modified (diff)

comment:18 Changed 2 years ago by ross

  • Milestone changed from ckan-sprint-2012-05-15 to current-ckan-sprint-2012-05-29

comment:19 Changed 2 years ago by rgrp

  • Description modified (diff)

This looks great Ross. Couple of things not included (which I have taken liberty of adding to the description as well - you will probably want to tidy up):

  • Related is a pretty terrible name in the UI - much better to have it called Apps, Ideas etc (perhaps title tag could even give more details e.g. "Apps, Ideas, Visualization and other material related to this dataset") -- btw i thought this was in #2332 but realize it wasn't (apologies for that!)
  • Documentation, documentation, documentation - AFAICT I can't see anything in v1.7 or master docs. I imagine this would be a short section like http://docs.ckan.org/en/ckan-1.7/commenting.html (and probably coming right after that in the ToC) which says
    • What it does
    • How to enable (and perhaps includes a nice-screenshot!)
    • How to customize (e.g. can one customize the list of options of things one can create (e.g. can I set it to just be app and idea or ...)
    • Also liase with Mark W re a blog post about this from the user perspective (a screenshot walkthrough ...)
  • Clearly mark this old extension as deprecated from v1.7 forward: https://github.com/okfn/ckanext-apps (I just met someone last week who was working on integrating this and had no idea it was replaced by something better in v1.7)

comment:20 Changed 2 years ago by ross

  • Description modified (diff)

comment:21 Changed 2 years ago by ross

  • Description modified (diff)

comment:22 Changed 2 years ago by ross

  • Description modified (diff)

comment:23 Changed 2 years ago by ross

  • Keywords [6d][r:2d] added; [6d] removed

comment:24 Changed 2 years ago by ross

  • Description modified (diff)

comment:25 Changed 2 years ago by ross

  • Description modified (diff)

comment:26 Changed 2 years ago by ross

  • Description modified (diff)

comment:27 Changed 2 years ago by ross

  • Milestone changed from current-ckan-sprint-2012-05-29 to current-ckan-sprint-2012-06-25

comment:28 Changed 23 months ago by ross

  • Keywords ui added

comment:29 Changed 23 months ago by shevski

Name-wise: what do we think of 'Related Media' - that suggests news articles, apps & visualisations to me

I'n not sure about relating 'ideas' to specific datasets. Looking at the way ideas work in DGU & pd.eu - it's more general and portal-wide so should flesh out user stories for this before adding ideas to related extension

comment:30 Changed 23 months ago by ross

  • Priority changed from awaiting triage to blocker
  • Description modified (diff)

Needs some UI work now, have changed status to blocker which appears to be the only way to denote something as blocked (awaiting resource).

comment:31 Changed 22 months ago by ross

  • Milestone changed from ckan-sprint-2012-06-25 to ckan-v1.8

comment:32 Changed 22 months ago by ross

  • Priority changed from blocker to awaiting merge

comment:33 Changed 22 months ago by icmurray

  • Owner changed from ross to icmurray
  • Status changed from new to assigned

Small fix to create action, outlined in [1] to be done. Said I'd do it, so moved ticket over to myself.

[1] https://github.com/okfn/ckan/pull/62

comment:34 Changed 22 months ago by icmurray

  • Status changed from assigned to closed
  • Resolution set to fixed
Note: See TracTickets for help on using tickets.