: Subject: Re: Solr Reference Guide pages; turn off comments?

Comments are pretty criticial to the current workflow o the ref guide, so 
i can't imagine turning them off completley.

: +1 to both ideas:  delete at the time we address a comment (rendering 
: the comment obsolete) and/or do so at release time if we neglected to 
: delete a comment earlier.  It’s a low-priority thing any way.

if a comment asks a question about content, or makes a suggestion about 
improving content, deleting that comment *immediately* after making that 
change would be a really bad idea because it would eliminate the context 
and teh flow of discussion.  Consider: 
  1) UserA asks about hte wording of a page
  2) CommitterB makes a fix
  3) UserA then has a followup concern about the fixed wording

if in #2 CommitterB deleted UserA's comment, that makes it awkware for 
UserA to post a followup to their initial comment w/o completley 
recreating the context.

Iview the comments on the ref guide as an almagamation of the comments in 
a Jira and the comments in source code -- a history of the feedback that 
resulted in the doc you see before you.  

I don't have any real concerns about the comments making hte pages long - 
they are at the bottom of hte page, out of the way, easily annotated by 
date so it's obvious when they might be old or stale.  Most importantly: 
they aren't included in the "released" doc.  The fact that they are in 
the online version is fine, the online version is by definition a draft 
for the upcoming release, when you see them, you are seeing how the 
sausage is made.  Perhaps more importantly: when you see them, you are 
seeing that comments are welcome and encouraged and useful to helping 
improve the doc moving forwad.


I would *love* to get the the point where we have pages with so many 
comment we are worried about how slow/big it makes those pages to 
load/read -- that would mean that things are going really well, and there 
is a lot of successful dialog and discussion about those pages -- but we 
aren't there yet.  

If the day comes when sometone looks at a particular page and says "damn, 
way too many old uselss comments here, we should prune these down" .. then 
they are certianly welcome to do so, we've said since day one that we 
*may* do this as needed...

https://cwiki.apache.org/confluence/display/solr/Internal+-+Maintaining+Documentation#Internal-MaintainingDocumentation-HowtoGiveFeedbackonThisDocumentation

...but i certainly don't think we should be too eager to do that 
immediately after addressing comments, nor do i think it's a big enough 
concern that we should formalize/automate when/how it's done on a regular 
basis.



-Hoss 
http://www.lucidworks.com/
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org
For additional commands, e-mail: dev-h...@lucene.apache.org

Reply via email to