Doctrine PHPCR

converting any existing docs to reST so that it can be added to the site

Details

  • Type: Documentation Documentation
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Fixed
  • Labels:
    None

Description

PHPCR ODM is listed on the Doctrine website:
http://www.doctrine-project.org/projects/phpcr_odm

build doc in this repository:

https://github.com/doctrine/phpcr-odm-documentation

The next step would be to collect all the various documentation flying around and convert them to reST format:
https://github.com/doctrine/phpcr-odm/wiki/_pages
http://melp.nl/2011/07/symfony2-phpcr-doctrine2-jackalope-recipe/ (needs to be made Symfony2 unspecific)
http://www.craftitonline.com/2011/07/first-symfony2-cmf-based-cms-pagesbundle/ (needs to be made Symfony2 unspecific)
http://cmf.symfony.com/slides.html (needs to be made Symfony2 unspecific)

any other articles flying around?

of course we should also reference PHPCR related docs

Activity

Descending order - Click to sort in ascending order
Hide
Permalink
David Buchmann added a comment -

wouldn't know of missing conversions. doc "just" needs to be completed by writing new chapters and improving the existing ones.

Show
David Buchmann added a comment - wouldn't know of missing conversions. doc "just" needs to be completed by writing new chapters and improving the existing ones.
Hide
Permalink
Lukas Kahwe added a comment -

is there anything left to still convert?

Show
Lukas Kahwe added a comment - is there anything left to still convert?
Hide
Permalink
David Buchmann added a comment -

did a lot of work today, the doc is now largely done, some chapters still missing

Show
David Buchmann added a comment - did a lot of work today, the doc is now largely done, some chapters still missing
Hide
Permalink
David Buchmann added a comment -

we should also point to this (resp. the place this gets online at http://cmf.symfony.com for usage of phpcr-odm inside symfony:
https://github.com/symfony-cmf/symfony-cmf-docs/blob/master/tutorials/installing-configuring-doctrine-phpcr-odm.rst

also note that the install instructions there are partially relevant for phpcr-odm without symfony too.

Show
David Buchmann added a comment - we should also point to this (resp. the place this gets online at http://cmf.symfony.com for usage of phpcr-odm inside symfony: https://github.com/symfony-cmf/symfony-cmf-docs/blob/master/tutorials/installing-configuring-doctrine-phpcr-odm.rst also note that the install instructions there are partially relevant for phpcr-odm without symfony too.
Hide
Permalink
David Buchmann added a comment -

it should be obvious, but the README file of the https://github.com/doctrine/phpcr-odm repository has a lot of the features documented. i propose that this is taken as starting point and once we have the doc up here on the doctrine website, strip down the README to a minum and reference the doc.

the phpcr doc entry point could be http://phpcr.github.com and then we have to work on improving that site too.

Show
David Buchmann added a comment - it should be obvious, but the README file of the https://github.com/doctrine/phpcr-odm repository has a lot of the features documented. i propose that this is taken as starting point and once we have the doc up here on the doctrine website, strip down the README to a minum and reference the doc. the phpcr doc entry point could be http://phpcr.github.com and then we have to work on improving that site too.
Hide
Permalink
Luis Cordova added a comment - - edited

yes it should be something like http://github.com/doctrine/phpcr-odm-documentation

and first commit should have the same structure for doc generation that orm-documentation has

then we can start PR'eing...

hand raised @lsmith

Show
Luis Cordova added a comment - - edited yes it should be something like http://github.com/doctrine/phpcr-odm-documentation and first commit should have the same structure for doc generation that orm-documentation has then we can start PR'eing... hand raised @lsmith

People

  • Assignee:
    David Buchmann
    Reporter:
    Lukas Kahwe
Vote (1)
Watch (2)

Dates

  • Created:
    Updated:
    Resolved: