Re: collective-docs deserves a prominent link on plone.org

Alex Clark <[email protected]>
Newsgroups gmane.comp.web.zope.plone.website,gmane.comp.web.zope.plone.documentation
Message-ID <[email protected]>
On 12/9/10 3:28 PM, Dylan Jay wrote:
> I think we need to keep the plone.org copy for a eat our own dog food
> stance plus so search works.

I think that is debatable, but I see your point. Personally, I'm not 
going to champion that cause right now because I'm swamped. But you are 
already doing all the work anyway ;-)

In general, I agree it's nice to be able to upload the c.developermanual 
content to PHC. But I have "maintenance phobia" about a lot of Plone 
infrastructure these days.


> Is it confusing to keep both though?


Not IMHO. We have a few cases like this where some community member 
argues for an alternate presentation of the same data (c.f. Wiggy and 
the plone theme vs. trac theme debate of 2009).

Presentation and UI are important, and Sphinx gets it right IMHO 
(elegant, simple, just works, does not get in the way, etc.)

Anyway, let's not forget the subject of this thread: displaying 
c.developermanual prominently on http://plone.org/documentation (with a 
link to 
http://plone.org/documentation/manual/plone-community-developer-documentation)

Who can we get to do this? I nominate Jon Stahl! (Because I believe he 
was the last one to re-org/cleanup that page).

I'd suggest, if others don't mind, that we somehow include a link to 
http://collective-docs.plone.org with the text "View Sphinx docs" ; 
perhaps with an explanation somewhere about how the docs made it into 
PHC (there are already docs on that in c.developermanual IIRC).

That way it's clear that:

- These docs are important and up to date (because we link to them right 
away on plone.org/documentation)

- These docs were created in Sphinx and you can easily view the Sphinx 
generated source (because we link to collective-docs.plone.org, where 
you can also view the original restructured text IIRC)

- These docs were easily imported to Plone via funnelweb (because Plone, 
Sphinx, and funnelweb are awesome :-))



Alex










>
> Also the other developer manual is being merged in. Once that's done
> we will have one developer manual. I'd suggest we just call it the
> plone developer manual and drop community?
>
> Dylan Jay
> Technical solution manager
> PretaWeb 99552830
>
> On 09/12/2010, at 4:26 PM, Alex Clark<[email protected]>  wrote:
>
>> On 12/9/10 12:11 AM, ajung wrote:
>>>
>>>
>>> aclark wrote:
>>>>
>>>> On 12/8/10 11:31 PM, ajung wrote:
>>>>>
>>>>> Hi there,
>>>>>
>>>>> collective-docs.plone.org is an extremely useful information source and
>>>>> contains very good information. The site deserves a prominent link under
>>>>> the
>>>>> documentation section. Collective is general much better that what we are
>>>>> having in the documentation section (at least when it comes to direct
>>>>> programming issues).
>>>>
>>>>
>>>> I agree (as I created that vhost), but the current consensus AFAIK is
>>>> that the collective-docs content should be shoved into PHC instead. In
>>>> fact, Moo has asked that the collective-docs vhost be redirected to
>>>> http://plone.org/documentation/manual/plone-community-developer-documentation.
>>>>
>>>> I'd be curious to see what you think about
>>>> http://plone.org/documentation/manual/plone-community-developer-documentation
>>>> vs. http://collective-docs.plone.org/ in terms of usefulness.
>>>> Personally, I like http://collective-docs.plone.org/ because the Sphinx
>>>> UI is awesome.
>>>>
>>>> (Also FYI I just updated: http://collective-docs.plone.org/. I'll put it
>>>> back on cron after we get the "new deus")
>>>>
>>>>
>>>> Alex
>>>>
>>>>
>>>>
>>>>>
>>>>> -aj
>>>>
>>>>
>>>> -
>>>>
>>>
>>>
>>> No particular preference (although I love the current look&   feel of the
>>> Sphinx site).
>>> The point is that a programmer visiting plone.org/documenation must see a
>>> link
>>> to the collective-docs at the first glance.
>>
>>
>> Right, it's two clicks in at the moment. Additional resources ->  Manuals
>> ->  Plone Community Developer Documentation. I'd say open a plone.org
>> just so we don't forget.
>>
>>
>>>
>>> -aj
>>
>>
>> --
>> Alex Clark · http://aclark.net
>> Author · http://aclark.net/admin
>>
>>
>> ------------------------------------------------------------------------------
>> This SF Dev2Dev email is sponsored by:
>>
>> WikiLeaks The End of the Free Internet
>> http://p.sf.net/sfu/therealnews-com
>> _______________________________________________
>> Plone-website mailing list
>> [email protected]
>> https://lists.sourceforge.net/lists/listinfo/plone-website
>> The Wiki: http://plone.org/development/current/projects/WebsiteTeam
>
> ------------------------------------------------------------------------------
> _______________________________________________
> Plone-website mailing list
> [email protected]
> https://lists.sourceforge.net/lists/listinfo/plone-website
> The Wiki: http://plone.org/development/current/projects/WebsiteTeam
>


-- 
Alex Clark · http://aclark.net
Author · http://aclark.net/admin


------------------------------------------------------------------------------
Lotusphere 2011
Register now for Lotusphere 2011 and learn how
to connect the dots, take your collaborative environment
to the next level, and enter the era of Social Business.
http://p.sf.net/sfu/lotusphere-d2d
_______________________________________________
Plone-website mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/plone-website
The Wiki: http://plone.org/development/current/projects/WebsiteTeam
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.