Re: Drafting the documentation page

John Schinnerer <john-/Gao9/[email protected]>
Newsgroups gmane.comp.web.zope.plone.documentation
Message-ID <[email protected]>
Aloha,

On 12/02/2010 08:12 AM, Israel Saeta Pérez wrote:
> On 02/12/10 00:40, John Schinnerer wrote:
>> Aloha,
>>
>>> Israel Saeta Pérez wrote:
>>>>
>>>> Hey,
>>>>
>>>> Nicolas Vasseur has been working on a cleaner plone.org/documentation
>>>> page. Please check:
>>>>
>>>> http://plone.org/documentation/helpcenter_ploneorg2
>>>>
>>>> and tell us what you think. We want something clean and simple, pointing
>>>> to our best manuals, as agreed before, and with links to other sections
>>>> like the KB, error reference, faqs...
>>>>
>>>> Any comments appreciated!
>>
>> So far so good overall, I would say. Seems pretty obvious where to go
>> for what, and there's not so much at once that it's overwhelming.
>>
>> The "by topic" sidebar is a good thing to have.
>> And I would suggest put newest stuff first, oldest stuff last in what is
>> displayed via those sidebar links.
>> For example when I click on 'visual design' under 'Customizing Plone' in
>> that sidebar, the second item displayed under "creating theme products"
>> is "Creating a new theme for Plone: a real-world example (Plone 2.1,
>> 2.5)". I suggest it ought to be down at the end of that section with the
>> link to the old DIYPloneStyle 2.x item.
>> In short, list Plone 4 and/or non-version-specific, and then 3.x, and
>> then 2.x.
>> Also, some indication as to what the gold stars next to an item mean.
>
>
> I think that these lists of content are collections generated
> programatically, so we don't have too much control of the sorting.
> Showing the starred items first, then by date is an option, though.
> Would you agree with that?

Yeah, I was assuming they are collections (which are great for 
collecting but could use more sorting abilities :-)...
Anything that would put them in order of newer plone stuff first would I 
think help, so by date ought to do it (2.5 stuff should have an older 
date than 3, and 3 older than 4, yes?)

> Also, some elements show up at the same page in several different
> categories, which is wrong. I think that we should remove most
> categories and leave just "Installing and upgrading" (would cover also
> moving and buildouts config), "Customization" (would cover every
> customization that doesn't need coding) "Theming" and "Development"
> (would include i18n/l10n). This is just a suggestion. I think that the
> less topics the better, since people nowadays don't browse documentation
> by topic, but use Google to search by terms, which is much smarter.

I generally agree with the above.

Also great work on addressing others' comments, it seems yet cleaner and 
clearer now, thanks!

cheers,
John S.



-- 
John Schinnerer - M.A., Whole Systems Design
--------------------------------------------
- Eco-Living -
Whole Systems Design Services
People - Place - Learning - Integration
[email protected]
http://eco-living.net

------------------------------------------------------------------------------
Increase Visibility of Your 3D Game App & Earn a Chance To Win $500!
Tap into the largest installed PC base & get more eyes on your game by
optimizing for Intel(R) Graphics Technology. Get started today with the
Intel(R) Software Partner Program. Five $500 cash prizes are up for grabs.
http://p.sf.net/sfu/intelisp-dev2dev
_______________________________________________
Plone-docs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/plone-docs
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.