Project

General

Profile

Feature #2606

Upgrade to latest BuddyPress Docs

Added by Boone Gorges over 8 years ago. Updated about 7 years ago.

Status:
Resolved
Priority name:
Normal
Assignee:
Category name:
BuddyPress Docs
Target version:
Start date:
2013-05-28
Due date:
% Done:

0%

Estimated time:
25.00 h

Description

We haven't upgraded BuddyPress Docs in well over six months, because of some major interface changes that took place with version 1.2 of the plugin. The major changes were:

- Docs no longer necessarily tied to group
- Single Docs no longer viewed in the context of a group (groups still have Doc directories)
- To show the now-optional group affiliation, there is now a "permissions snapshot" at the top of each Doc
- Users now have Docs tabs on their profiles (Started by me, Edited by me)
- An optional top-level nav item, Docs, is introduced
- As of about a week ago, Docs now allow file attachments

We should get back up to date, but before doing so, I would like Chris and probably Matt to do a review of the current state of Docs, focusing on the items above.

FWIW, all these changes have been heavily tested by thousands of users in the wild, so I feel comfortable with all of them. The only change we may want to hold off on on the Commons is attachments - if we enable them, it's yet another place where people will be able to attach files, which may create fragmentation. We may want to wait until I've written a migration script from BuddyPress Group Documents, the plugin we currently use for Files.

I'm going to upgrade cdev to the latest Docs, and post a few links for you to have a look at. Thanks in advance for the feedback.

History

#1 Updated by Matt Gold over 8 years ago

Thanks, Boone. Please give the ticket a bump when cdev is updated. What is your ETA for the migration script from BP Group Docs? Is this something we might conceivably make part of our next milestone release, to be done later this summer?

#2 Updated by Boone Gorges over 8 years ago

cdev has now been updated. Here are a few things to check out:
- Global Docs directory: http://cdev.gc.cuny.edu/docs/
- Single Doc: http://cdev.gc.cuny.edu/docs/public-group-test-doc/
- User Doc page: http://cdev.gc.cuny.edu/members/boonebgorges/docs/started/
- Edit page, including attachments interface http://cdev.gc.cuny.edu/docs/public-group-test-doc/edit/

Note that there is some obvious styling work to do. All I've done is upgraded the plugin - no customizations yet.

Please take a few minutes to look around. There are some changes from our current implementation, but I think they are all improvements. (I am also biased.)

What is your ETA for the migration script from BP Group Docs?

No ETA. Writing the migration script will not be too complicated. I'm more concerned about the fact that our end goal is getting rid of the Files tab, which is going to require a fair amount of UX (and documentation) consideration. So there should be some internal discussion on our team before we start thinking about migrating away.

#3 Updated by Chris Stein over 8 years ago

Boone, sorry I'm coming to this late. I took some time off and am clearing a backlog. At first look the basic functionality looks good. My one quick comment on that is that for me there was an "edit this page" link still at the bottom of the page for docs I could edit and clicking on that opened the doc in the dashboard in post edit mode.

I'd like to take the time to do some more thinking on how we might approach the global docs page and helping people find docs. But that could be something for round two of this. There may also be a few tweaks I have to suggest when looking at it a bit longer.

As you mentioned it needs more styling work. Do you want input on that now or do you want to do some more work on it and then get feedback?

#4 Updated by Matt Gold over 8 years ago

Here's a link to a related discussion Boone and I have been having on the Redmine install for nycdh.org - http://redmine.gc.cuny.edu/issues/2651

#5 Updated by Boone Gorges about 8 years ago

  • Target version changed from 1.5 to Future release

We haven't made much progress on this discussion, so I'm moving this ticket out of the milestone. I've rolled Docs back to the current version in https://github.com/castiron/cac/commit/f4a49799780d6f18dd5ad8fb95bebb1e14091d25. It's working fine on the Commons as is, so let's not rush it.

#6 Updated by Matt Gold about 8 years ago

can we put this in 1.6 instead so that we don't lose sight of it? Future release to me is "someday, that would be nice if we can swing it" -- for example, the netflix-like suggestion system is something that is way beyond our capabilities right now but would be nice to have at some point. Bumping something to the next feature release, though, at least keeps it on our radar.

#7 Updated by Boone Gorges about 8 years ago

  • Target version changed from Future release to 1.6

#8 Updated by Matt Gold about 8 years ago

Thanks, Boone.

#9 Updated by Boone Gorges over 7 years ago

  • Category name set to BuddyPress Docs

#10 Updated by Boone Gorges over 7 years ago

  • Tracker changed from Feature to Design/UX
  • Target version changed from 1.6 to 1.7
  • Estimated time set to 25.00 h

This is not going to happen for 1.6. I would put it in Future Release, but the discussion above shows that this is frowned upon. So into 1.7 we go!

#11 Updated by Boone Gorges about 7 years ago

  • Tracker changed from Design/UX to Feature
  • Status changed from Assigned to Testing Required
  • Assignee changed from Chris Stein to Boone Gorges

As noted in our last meeting, I've grown tired of bumping this ticket, and of the inconclusive arguments regarding the UI. So I've built a shim plugin that allows us to upgrade to the latest BuddyPress Docs (gaining all of the relevant improvements and bug fixes) while keeping group Docs within the context of groups (the main point of friction in previous conversations).

BuddyPress Docs updated in https://github.com/cuny-academic-commons/cac/commit/ac98c39c3363dfb21b9b5765045f6fbdd65dd21a
Shim plugin added in https://github.com/cuny-academic-commons/cac/commit/4339823df93f3c15fe7d44401ca49a3090ff92fd

I've performed the necessary migration on cdev, and fixed a few bugs that showed up. It's ready for some testing and feedback from the rest of the team.

For the most part, you'll notice few changes - things just look a bit different here and there (hopefully better). I've disabled the Attachments feature for the time being, to avoid confusion with Group Files; I suggest we discuss this for a future milestone. One new feature is the Docs tab on user profiles - see http://cdev.gc.cuny.edu/members/boonebgorges/docs/ for an example.

#12 Updated by Matt Gold about 7 years ago

Just tested it by creating a new doc and things didn't feel out of joint to me at all. I had been worried about what would happen after one created a doc (ie., what page one would be directed to), but it was not a problem.

Very nice work. This seems ready to go to me. And I love the term "shim plugin"! A perfect fit.

#13 Updated by Boone Gorges about 7 years ago

And I love the term "shim plugin"! A perfect fit.

Not my invention! https://en.wikipedia.org/wiki/Shim_%28computing%29

I had been worried about what would happen after one created a doc (ie., what page one would be directed to), but it was not a problem.

Yes, that's what the shim does - it basically replicates the old workflow, by putting all of the group-related Doc stuff into the group interface.

I'll leave this ticket open for another day or two in case anyone else wants to put eyeballs on it. Thanks!

#14 Updated by Matt Gold about 7 years ago

Oh, man -- I thought it was from your background in carpentry!

#15 Updated by Boone Gorges about 7 years ago

  • Status changed from Testing Required to Resolved

Looks like this is settled. Thanks, everyone.

#16 Updated by Matt Gold about 7 years ago

Exciting -- really happy about this.

Also available in: Atom PDF