Skip to main content

Home/ Plone distributed documentation/ Group items tagged documentation

Rss Feed Group items tagged

Filter: All | Bookmarks | Topics Simple Middle
Graham Perrin

On Plone documentation - Martin Aspeli - 1 views

martinaspeli.net/...on-plone-documentation

2008 2008-11 2008-11-23 Plone (software)

shared by Graham Perrin on 01 Apr 10 - Cached
  • I think it's a mistake to try and solve all the problems with "Plone documentation" in the same way
    • Graham Perrin
      Graham Perrin on 01 Apr 10
       
      +1
  • rely more on technology
  • What is current good practice?
    • Graham Perrin
      Graham Perrin on 01 Apr 10
       
      My initial reaction to this: get started | essential actions | refinements and current best practice …
  • ...20 more annotations...
  • a corpus small enough that it can be effectively reviewed
  • highlighted and easy to find
  • this is where they should be stumbling
    • Graham Perrin
      Graham Perrin on 01 Apr 10
       
      Can we elaborate on this point?
  • Barriers to entry should be low
  • version the document pertains to
    • Graham Perrin
      Graham Perrin on 01 Apr 10
       
      +1
    • Graham Perrin
      Graham Perrin on 01 Apr 10
       
      Re http://dev.plone.org/plone/ticket/7831 some simple triggers might draw attention to documentation that becomes outdated (or at least deserves review) at product update time.
  • concerned about how easy it is to add an article
  • highlight the "good" bits of documentation
  • reviewed at least each time we make a new Plone release
  • What's the right way to configure caching?
    • Graham Perrin
      Graham Perrin on 01 Apr 10
       
      Advice may be diverse.
  • If someone wants to contribute documentation, by all means let them!
  • allow comments
  • ratings of the type "was this helpful to you"
    • Graham Perrin
      Graham Perrin on 01 Apr 10
       
      I do often rate things (positively more often than negatively). However: I rarely observe other people's ratings.
  • Open the flood-gates
  • group documentation by audience, rather than by type
    • Graham Perrin
      Graham Perrin on 01 Apr 10
       
      I'm never wholly convinced about audience-based documentation.
    • Graham Perrin
      Graham Perrin on 01 Apr 10
       
      Can we group documentation by layer - through the Plone (TTP), Zope management interface (ZMI), file system et cetera?
  • Accept that how-to documentation won't be perfect
  • Add ratings
  • improve commenting
  • this is out of date
    • Graham Perrin
      Graham Perrin on 01 Apr 10
       
      Maybe "This is valid for version n.n of product x" plus "For more recent advice please visit …".
  • We should allow people to make requests for new documentation, and expose the wish list in a way that lets people vote for their favourite requests
    • Graham Perrin
      Graham Perrin on 01 Apr 10
       
      First improvements to a document might be: (1) a link to Trac, so that any documentation-related issue can be tracked; and (2) an in-document summary of relative tickets.
  • We have a Trac
Israel Saeta Pérez

Creating Documentation for Plone.org - 0 views

plone.org/...tutorial-all-pages

plone plone.org documentation reference

shared by Israel Saeta Pérez on 17 Nov 08 - Cached
  • Israel Saeta Pérez on 17 Nov 08
     
    howto create documentation for plone.org
Graham Perrin

LearnPlone - 0 views

learnplone.onenw.org

shared by Graham Perrin on 29 Dec 08 - Cached
  • Graham Perrin on 29 Dec 08
     
    the end user documentation website for the Plone CMS
Graham Perrin

Can I annotate Gmane alternative views of list/forum activities? - 5 views

Maybe. Of three or more views of a message: http://article.gmane.org/gmane.comp.web.zope.plone.documentation/3393 http://thread.gmane.org/gmane.comp.web.zope.plone.documentation/3005/focus=339...

started by Graham Perrin on 12 Nov 08 no follow-up yet
Graham Perrin

Minutes, May 29, 2008 - Plone CMS: Open Source Content Management - 0 views

plone.org/...minutes-may-29-2008

deprecation Plone support major minor version policy minutes p2664667

shared by Graham Perrin on 21 Apr 09 - Cached
  • impact of faster 0.1 releases
  • messaging and perception
  • deprecation policy
    • Graham Perrin
      Graham Perrin on 21 Apr 09
       
      deprecation ≠ support
  • ...5 more annotations...
  • the intent is to support two major versions
  • our official policy is that we support the most recent two major versions
  • need to update version numbering policy
  • http://plone.org/documentation/manual/upgrade-guide/introduction
  • reflect current practices
Graham Perrin

Performance of Plone in concert: plea for updated documentation and/or a cheat sheet - 0 views

n2.nabble.com/-tp360002p360002.html

shared by Graham Perrin on 30 Dec 08 - Cached
  • Graham Perrin on 30 Dec 08
     
    Review (maybe change) this list some time after upgrade of plone.org is complete, allowing for things to settle and prove themselves.
Graham Perrin

DCWorkflow documentation - 2 views

zope.org/...DCWorkflow_docs

Plone workflow

shared by Graham Perrin on 29 Dec 08 - Cached
  • 2001-12-20
    • Graham Perrin
      Graham Perrin on 29 Dec 08
       
      In irc://irc.freenode.net/#plone in late 2009, this 2001 content is recommended despite its age. DCWorkflow is well-designed.
Graham Perrin

Approving articles and edits - 0 views

support.mozilla.com/...Approving+articles+and+edits

comparator documentation

shared by Graham Perrin on 16 Nov 08 - Cached
  • Graham Perrin on 16 Nov 08
     
    Treating this mozilla.com page as a comparator.
Graham Perrin

Installing Plone v3.2 on Mac OS X 10.5 - GSE&IS Plone Development Site - 0 views

webdev.gseis.ucla.edu/...ng-plone-v3.2-on-mac-os-x-10.5

shared by Graham Perrin on 25 Mar 09 - Cached
Israel Saeta Pérez

Sapere aude! · Creating a new content-type with Archetypes in Plone 3 - check... - 0 views

dukebody.com/?p=82

plone documentation

shared by Israel Saeta Pérez on 15 Feb 09 - Cached
  • Israel Saeta Pérez on 15 Feb 09
     
    Creating content-types checklist.
Graham Perrin

#7662 (Trails trails trails...) - Plone - Trac - 0 views

dev.plone.org/7662

trail

shared by Graham Perrin on 30 Dec 08 - Cached
  • Trails have been deprecated. See #7836.
Graham Perrin

#7836 (Come up with a suggested Information Architecture for the documentation) - Plone... - 0 views

dev.plone.org/7836

trail

shared by Graham Perrin on 30 Dec 08 - Cached
  • audience-based trails and topic trails have been abandoned
  • trailheads may be worthwhile
Graham Perrin

The Zope Book (2.6 Edition): Acquisition - 0 views

www.zope.org/...Acquisition.stx

2009 Zope acquisition Plone (software) unread

shared by Graham Perrin on 26 Feb 10 - Cached
  • Acquisition
  • allows dynamic behavior to be shared between Zope objects
  • containment
  • ...4 more annotations...
  • understanding of acquisition is important
  • Acquisition vs. Inheritance
  • Objects are situated inside other objects. These objects act as their "containers".
  • may acquire behavior from their containers
Graham Perrin

Python debugger (pdb) - Plone Developer Manual v0.1 documentation - 0 views

plonemanual.twinapex.fi/...pdb.html

2010 2010-01 2010-01-10 Plone (software) Python (programming language)

shared by Graham Perrin on 12 Jan 10 - Cached
  • Python debugger
  • (pdb)
  • interactive command-line debugger
  • ...3 more annotations...
  • Useful pdb commands
  • s = step into, go into the function in the cursor n = step over, execute the function under the cursor without stepping into it c = continue, resume program bt = print stack trace up = go to the scope of the caller function
  • Useful pdb snippets
1 - 20 of 29 Next ›
Showing 20▼ items per page