Path

ez projects / doc / forum / general / is this the best medium for...


Is this the best medium for the job?

You need to be logged in to post messages in the forums. New users may register here.

Geoff Bentley

Member since:
08 December 2007

Posts: 47

Monday 13 July 2009 2:12:28 am

I applaud the concept of community documentation - for years, comments have been added to the online documentation providing information not within the docs; and community members are more likely to provide documentation, as an easy way to give back to the community (see forums).

However, I don't think forums + SVN /docs are the best way to contribute. I think a wiki + discussions would serve the online community better, and could inform the official documentation.

Your thoughts?
Up

André R

Member since:
20 August 2005

Posts: 171

Tuesday 14 July 2009 12:36:00 am

Sure, I just saw a need to have a place to discuss doc and if possible organize people who are interested in contributing. Svn was just added since you get it anyway with projects.

Comments are are not a good way to discuss, only to add remarks on doc page / articles.
ezpedia does not have any collaboration features as far as I know.
But yes, this could have been solved with a separate doc forum on ez.no, and just use ezpedia for stub articles / work in progress pages.

--
ar

Up

Kristof Coomans

Member since:
12 February 2004

Posts: 68

Tuesday 14 July 2009 11:26:44 am

ezpedia.org is willing to collaborate on this. In the past the idea was to have a forum under each page, allowing for people to start any discussions regarding that page. I am not sure this is the best way to continue, but I believe it's certainly better than one discussion page.

Please be aware that ezpedia.org is independant and not a project lead by eZ Systems, so we (the independant eZ open source community) will have the final call on what is done there.

independent eZ Publish developer and service provider | http://blog.coomanskristof.be | http://ezpedia.org

Up

// Heath

Member since:
04 March 2007

Posts: 94

Sunday 19 July 2009 7:15:29 pm

Hello,

I found an example of the eZpedia
discussion system that was created
but not yet used.

http://ezpedia.org/en/ez/cache/di...n_of_how_to_clear_cache_why_and_when

Today is a great time to start new conversations!

Cheers,
Heath

Brookins Consulting | http://brookinsconsulting.com/
Certified | http://auth.ez.no/certification/verify/380350
Solutions | http://projects.ez.no/users/community/brookins_consulting
GitHub | https://github.com/brookinsconsulting
eZpedia community documentation project | http://ezpedia.org
eZecosystem - eZ Publish Planet | http://ezecosystem.org
eZPublishLegacy - eZ Publish Release Mirror | http://ezpublishlegacy.com

Up

André R

Member since:
20 August 2005

Posts: 171

Monday 20 July 2009 9:09:51 am

Nice. But would be slightly better with the following small enhancements:
* Link to the topic in the forum / forum topic template, if possible also the description / intro of the wiki entry (if this is used).
* make the left menu about the entry, even when you browse the forum underneath it.

--
ar

Up

// Heath

Member since:
04 March 2007

Posts: 94

Wednesday 19 August 2009 2:15:16 am

@ André R.

Thank you Andre!

Per your request I have made the following modifications.

1. Linked to the forum topic in the forum template (this way the discussion menu link remains displayed even when within the forum / forum topic).

2. Description ... I'm considering your request for a description / intro of the wiki entry. I'm not sure how best to implement offhand since the wiki articles do not have a short description / intro field within the entry.

For now I added a link within the forum template to display the name of the wiki article with return link.

3. Thread message display order - I have also reversed the default order to display messages (as most recent) first to help avoid unnecessary scrolling or pagination and improve usability.

4. Latest updates rss feed - I have added an rss feed with only the latest updated conteent objects on ezpedia. http://ezpedia.org/rss/updated/discussion

5. Latest discussion (only) updates rss feed - I have added an rss feed with only the latest updated content objects on ezpedia. http://ezpedia.org/rss/updated/discussion

6. Homepage - Layout - I have also added a list of recent discussions into the homepage layout. http://ezpedia.org/

Take a look at the changes and let me know what you think.

Cheers,
Heath

Brookins Consulting | http://brookinsconsulting.com/
Certified | http://auth.ez.no/certification/verify/380350
Solutions | http://projects.ez.no/users/community/brookins_consulting
GitHub | https://github.com/brookinsconsulting
eZpedia community documentation project | http://ezpedia.org
eZecosystem - eZ Publish Planet | http://ezecosystem.org
eZPublishLegacy - eZ Publish Release Mirror | http://ezpublishlegacy.com

Up

André R

Member since:
20 August 2005

Posts: 171

Thursday 20 August 2009 10:54:39 am

Nice Heath!

Comments:
1. I wouldn't add description attribute if it isn't already there, maybe a operator to get first paragraph using a simple DOMDocument->getElementsByTagName call, but not really needed.

2. Seems like a general discussion is going on in there*, that could work if we had one big syndicated community site that pulled in discussions from several sites. But until then I think general discussions should be on ez.no/developer, leaving only article / ezpedia.org discussions in there*.


* http://ezpedia.org/en/ez/discussions/discussion

--
ar

Up

Gaetano Giunta

Member since:
30 November 1999

Posts: 269

Saturday 14 November 2009 12:43:33 pm

I second the fact that discussions in there should only relate to ezpedia content.
They should imho also be visually better identified as not being articles per-se, but comments relating to a given article...

Principal Consultant International Business
Member of the Community Project Board

Up

You need to be logged in to post messages in the forums. New users may register here.