Closed (won't fix)
Project:
Documentation
Component:
Docs infrastructure
Priority:
Major
Category:
Task
Assigned:
Unassigned
Issue tags:
Reporter:
Created:
14 Jan 2011 at 23:43 UTC
Updated:
18 Oct 2011 at 20:26 UTC
Problem/Motivation
As part of #1278256: Develop a plan to make it more clear that the current Documentation on drupal.org is community maintained.
We want to have a Discussion tab on Book pages in the newly revamped "Community Documentation" section. We would rather use linked Forums than the current comments, because:
- They can be separated by topic.
- More flexible.
Proposed resolution
To do this, we need to:
a) Un-deprecate the existing Documentation forum http://drupal.org/forum/33
b) Add a multi-valued nodereference field to Forum posts (only visible on this forum), which would reference one or more Book page nodes.
c) Make a block that would show the most recent Forum posts referencing a book page (with Views arguments/contextual filters), to be displayed on the Book page sidebar (see mockup at http://drupal.org/files/issues/docs_ideal_wf_v4.jpg)
d) Make a Discussions page, to be displayed as a tab on a Book page (see mockup above). This page should look I think like the forum landing page http://drupal.org/forum/33 except it should be specific to discussions for this book page only, and should have a link to add a new discussion for this book page.
e) To make this work, there should be a way to pass the node ID of the book page into the URL, something like http://drupal.org/node/add/forum/33?bookref=12345 and that would auto-fill the nodereference field. We also need this type of a URL to work so that we can use it in other places on the book page itself (link to "post a new discussion about this page" etc.).
Remaining tasks
All tasks listed above need to be done.
User interface changes
See proposed change - it's all UI.
API changes
None.
Original report by jhodgdon
Since we want to get rid of comments on doc book pages
#810508: Kill handbook comments
maybe it would be useful to be able to link forums to book pages, so we could have a block showing "forums related to this page" on the doc sidebar?
Similar to what is proposed for issues in
#995292: Noderef field on issues for Documentation project
Comments
Comment #1
arianek commentedmy only worry here is that forums never get "closed" like an issue, so.... the block could get crazy long, but obviously we can limit it somehow.
if we do this, we should just make it obvious somehow that docs team doesn't officially monitor the forum posts.
Comment #2
jhodgdonSuggested workflow/process here:
a) Any new forum thread has a noderef field that can list one or more doc pages it is related to.
b) If possible, as in issues (see #995292: Noderef field on issues for Documentation project), forum comments could modify this list.
c) We have a new collapsible block showing up to 5 most recent forums related to this page (i.e. having a noderef to this page).
d) It's called "Related community discussions", to make it clear it's not officially documentation.
f) At the bottom of this block, whether there are any forums or not shown, there will be a "Start a new discussion" link that will take you to add new forum post page. Not sure which forum taxonomy it should go in? and can we auto-fill the noderef?
Comment #3
arianek commentedThat all sounds reasonable to me.
There is a "deprecated" docs forum that seems to still be used a little http://drupal.org/forum/33 (I noticed the forum desc had links to the mailing list, so I updated them). We could potentially revive it if that seems like a better route for people to give each other support rather than relying on the issue queue.
Comment #4
jhodgdonThis is now an important component of #1278256: Develop a plan to make it more clear that the current Documentation on drupal.org is community maintained. and I'll edit the issue summary shortly to reflect our current needs. Moving back to the docs queue meanwhile.
Comment #5
jhodgdonIssue summary has been updated. Changing title as well.
Comment #5.0
jhodgdonOverhaul issue summary
Comment #6
jhodgdonIssue summary updated to point to new mockup
Comment #7
yoroy commentedI'd very much like to help here. Abilities to cross-link related content is a much needed functionality. Please don't fear the Prairie tag :) Related issue #1290740: How to label, aggregate and expose issues, docs, forum posts and groups to Topic pages
Comment #8
jhodgdonPlease feel free to take on this issue -- we need someone to just do it. :) What needs to happen is shown in the issue summary.
The way to make it happen would be to get a d.o test site, develop the changes there, get people to review them, make it all into a feature, get it added to the drupalorg project, and then get it deployed on drupal.org. A more detailed guide to doing this is at:
http://drupal.org/node/1006562
(yoroy - you may not need that information, but in case someone else comes along who does...)
Actually there is already a test site you can use, called "issue_noderef", which was set up for this issue that we decided we don't need now:
#995292: Noderef field on issues for Documentation project
So that test site can be used for this issue, unless drumm comes along here and says otherwise.
Comment #9
jhodgdonWe've gone back to "no" on this -- the infra team wants to avoid having too much change and too much custom on the site, as it will make updating to Drupal 7 harder. So I think we are back to wanting to just use comments instead of forums.
Comment #9.0
jhodgdonlink to new mockup