collective / collective.developermanual

Plone Developer Manual - the source code of developer.plone.org

This repository is no longer used.

Please go to github.com/plone/documentation instead.

collective.developermanual's Issues

TODO app tutorial is incomplete and useless in its current form

It is missing the first step to actually create a product and put it into your buildout to get started.

Discuss with Chris E, Steve M and Necj how to solve this so that we have a complete story for starting Plone development.

Errors in Epub version

1. Go to http://readthedocs.org/projects/collective-docs/downloads/, and download the Epub version.
2. Load the Epub version on an iPad
3. Open it on the iPad in iBooks

Result:

Most of the sections start with an error:

This page contains the following errors:
error on line 266 at column 11:  Opening and ending tag mismatch: br line 0 and body
Below is a rendering of the page up to the first error.

The line and column numbers are different in each error, but the message is the same.

Apart from the error itself, I haven't found anything missing. The pdf version works fine on the iPad.
The Epub version also works fine on my Mac in Adobe Digital Editions.

Create instructions how to install a trunk version of add-on from Github

See http://plone.293351.n2.nabble.com/General-Questions-f293352.html

Cross-reference documentation in Plone user interface

In some critical points, have deep links in Plone user interface to the related developer documentation

Underline styles for chapter/section titles

Hi,

It seems that sections marking is not homogeneous across the documentation. Sometimes, level 1 sections are underlined with "=", sometimes with "-". And the "mess" continues for the sub(...)sections.

There is a pretty good conventions here http://sphinx.pocoo.org/rest.html#sections but perhaps we could have better suited ones clearly indicated in the "writing.txt" file https://github.com/collective/collective.developermanual/blob/master/source/introduction/writing.txt

Cheers.

Only one authorative place for system dependencies list when installing Plone

Currently we have multiple places where apt-get poem for Ubuntu / Debian is told

• Unified installer README
• http://plone.org/documentation/manual/installing-plone/installing-on-linux-unix-bsd/debian-libraries
• http://collective-docs.readthedocs.org/en/latest/getstarted/installation.html#installing-plone-using-the-unified-unix-installer

To make sure that the information will stay updated. I'd take "unofficial" versions down and replace them with a link to the official version.

Steve: What you do think is the right place to host this information?

Upgrade plone.org documentation splash page

Move the rest of developer documentation out of p.org old dev section to collective-docs

Lovely snippet for inclusion: overriding a portlet

Logging this here so it isn't forgotten.

On Thu, Oct 25, 2012 at 3:06 AM, Jens W. Klein [email protected] wrote:

On 2012-10-24 20:56, Tarlika Elisabeth Schmitz wrote:
I would like to display the items in the navigation portlet in reverse
chronological order.

Any advice how to achieve this would be greatly appreciated.

Best is to override navigation trees querybuilder.

The interface of this adapter is
plone.app.layout.navigation.interfaces.INavigationQueryBuilder

To achieve this just subclass default querybuilder, see
https://github.com/plone/plone.app.portlets/blob/master/plone/app/portlets/portlets/navigation.py#L294
and add the methods sortAttribute and sortOrder, ie.:.

from plone.app.portlets.portlets.navigation import QueryBuilder

class MyQuerybuilder(QueryBuilder):

    def sortAttribute(self):
       return 'created'

    def sortOrder(self):
       return 'reversed'

Then create and integrate (buildout -> zcml-overrides) an overrides.zcml
and register your adapter to replace the default one.

hth Jens
Klein & Partner KG, member of BlueDynamics Alliance

Email and errors

The documentation at http://collective-docs.readthedocs.org/en/latest/misc/email.html is incorrect as it does not supply the immediate=True parameter which causes an email to be sent immediately (and any error raised) rather than sent at the transaction boundary or queued for later delivery.

Update how to change logo for Plone 4

Outdated, does not work with P4: http://plone.org/documentation/kb/change-the-logo-in-plone-3

Breaks on title attribute

tal:content="context/@@plone_portal_state/portal_title"

TODO app tutorial is incomplete and useless in its current form

It is missing the first step to actually create a product and put it into your buildout to get started.

Discuss with Chris E, Steve M and Necj how to solve this so that we have a complete story for starting Plone development.

Migrate old Theme Reference to collective-docs

We need Plone 3.x theme reference migrated.

This task is pending transmogrifier.command + pandoc pipeline

add section about developing tools/preparation

like:

you need an editor [sublime, vim]
config of editor
vcs
...

Make collective-docs splash page

The current index.rst is not that nice. Find a person which visual and HTML skill and make him/her to sit with us and get it done.

Highlight developer tutorial

Make sure the official tutorial works and is highlighted on plone.org as the first step

Cater different developers

• Theme developer
• Content type developer
• Form developer

First of course make sure those tutorial exists.

Updated portlets manual and tutorial

• Current manual is not connected to templer templates
• It uses zope.formlib

Need to be rewritten with z3c.form by someone who has the knowledge

Fix Sphinx errors

We have Sphinx (restructured text) syntax errors in the manual. The goal is to have zero syntax errors: then we can have a robot to notify #plone-docs IRC channel if someone edits the content and leaves in syntax errors.

Syntax errors come from

• Due to partially machine made migration from plone.org to collective.developermanual
• Human errors
• Copy-pasted .rst content from somewhere else

This ticket is a master ticket to clean up syntax errors.

• Each participant will tell the name of the section they are working on in the comments
• Run make clean ; make html until your section is polished
• Do git push (no pull request needed)
• Repeat until collective.developermanual is clean from Sphinx errors

Intersphinx documentation build

How we can build individual Plone package documentation under collective-docs

Domen knows

Make content type explanation

How they are "forms" for editing content in different parts of the site

Dexterity Sphinx migration

Migrate Dexterity manuals to Sphinx.

Please poke me when done, so let's embed them to collective.developermanual

Update all tutorials Unified Installer + ZopeSkel based

All tutorials should be based on Unified installer and ZopeSkel, as that what novice users use. No custom buildouts or virtualenvs allowed.

update python version on writing.rst

update to 2.7 to build documentation ?

Dexterity Sphinx migration

Migrate Dexterity manuals to Sphinx.

Please poke me when done, so let's embed them to collective.developermanual

Populate the default installed src/ with skeleton for creating something

So you could just paste in code into views.py

Not running buildout.

update python version on writing.rst

update to 2.7 to build documentation ?

Writing style and standards for the CDM

Make all the developer manual consistent about writing style and standards. Ideally it should become much more story telling and fluent

Dexterity Sphinx migration

Migrate Dexterity manuals to Sphinx.

Please poke me when done, so let's embed them to collective.developermanual

Have working Travis CI notifications

Authorize people to use plone.org

Who to speak?

Who to authorize?

Make sure people have contribution agreements signed?

Change support splash page

Make it more clear

source/components/zcml.rst refers to file which doesn't exist (serving/layers)

/Users/bdbaddog/devel/plone/collective.developermanual/source/components/zcml.rst:77: WARNING: unknown document: serving/layers

Document how to update plone.org help center

New theme tutorial

Have a plone.app.theming tutorial

Add to the commit team config

I'm a member of the organization at https://github.com/collective but the checkout links are read-only:
https://github.com/collective/collective.developermanual

Looks like collective.developermanual needs to be added to https://github.com/organizations/collective/teams/69277 ?

add section about developing tools/preparation

like:

you need an editor [sublime, vim]
config of editor
vcs
...

Bootstrap documentation team

Make sure we have "the team" defined

• Who they are
• They are on plone-docs mailing list
• They are on #plone-irc channel

update python version on writing.rst

update to 2.7 to build documentation ?

Migrate old Theme Reference to collective-docs

We need Plone 3.x theme reference migrated.

This task is pending transmogrifier.command + pandoc pipeline

TODO app tutorial is incomplete and useless in its current form

It is missing the first step to actually create a product and put it into your buildout to get started.

Discuss with Chris E, Steve M and Necj how to solve this so that we have a complete story for starting Plone development.

Writing style and standards for the CDM

Make all the developer manual consistent about writing style and standards. Ideally it should become much more story telling and fluent

auto-doc for core for embrassement driven development

1. Narrative style
2. Reference style

• Interfaces
• Every viewlet
• Every view
• GenericSetup handlers

Remove lenghty note "Edit this document..." from epub or make it a one-liner

In http://readthedocs.org the generate HTML for the manual includes side note on every page saying "Edit this document... The source code of this file is hosted on GitHub."

There are conveniently built PDF and epub versions at
http://readthedocs.org/projects/collective-docs/downloads/

The PDF does not contais the edit note, but the epub does. The note takes much screen real estate, which is something precious in a Kindle or other ebook readers.

I suggest the note is removed from the built epub.
Or maybe a little one-liner note could be put in its place.

add section about developing tools/preparation

like:

you need an editor [sublime, vim]
config of editor
vcs
...

Overriding views and viewlets with copy-pasting

Generate the override view and viewlet code inside Plone itself

Ship with development tools out of the box

See what the following packages could be included in the new unified installer command "bin/devserver" (equals to bin/instance fg with sauna reload)

• sauna.reload
• ipdb
• plone debug toolbar
• PdbDebugMode
• Other?

Writing style and standards for the CDM

Make all the developer manual consistent about writing style and standards. Ideally it should become much more story telling and fluent

Migrate old Theme Reference to collective-docs

We need Plone 3.x theme reference migrated.

This task is pending transmogrifier.command + pandoc pipeline

Screencast tutorials for TTW Diazo and Dexterity

Short, on the order of 5 minute, screencasts showing the basics of TTW content and theming. End with pointers to written tutorials.

NutJob is very good at this if he's willing.

Change documentation language?

Do we need to change our languages as our "integrators" are "developers" elsewhere?