Doctrine PHPCR
  1. Doctrine PHPCR
  2. PHPCR-21

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

    Details

    • Type: Documentation Documentation
    • Status: 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

        Lukas Kahwe created issue -
        Lukas Kahwe made changes -
        Field Original Value New Value
        Description PHPCR ODM is listed on the Doctrine website:
        http://www.doctrine-project.org/projects/phpcr_odm

        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
        PHPCR ODM is listed on the Doctrine website:
        http://www.doctrine-project.org/projects/phpcr_odm

        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

        we will need to create a new repository on https://github.com/doctrine/
        you can find the other documentations there too which could help as a starting point
        Hide
        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
        Hide
        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
        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.
        David Buchmann made changes -
        Description PHPCR ODM is listed on the Doctrine website:
        http://www.doctrine-project.org/projects/phpcr_odm

        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

        we will need to create a new repository on https://github.com/doctrine/
        you can find the other documentations there too which could help as a starting point
        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

        we will need to create a new repository on https://github.com/doctrine/
        you can find the other documentations there too which could help as a starting point
        David Buchmann made changes -
        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

        we will need to create a new repository on https://github.com/doctrine/
        you can find the other documentations there too which could help as a starting point
        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
        David Buchmann made changes -
        Assignee Jordi Boggiano [ seldaek ] David Buchmann [ dbu ]
        Hide
        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
        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
        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.
        David Buchmann made changes -
        Status Open [ 1 ] Closed [ 6 ]
        Resolution Fixed [ 1 ]

        This list may be incomplete, as errors occurred whilst retrieving source from linked applications:

        • Request to http://www.doctrine-project.org/fisheye/ failed: Error in remote call to 'FishEye 0 (http://www.doctrine-project.org/fisheye/)' (http://www.doctrine-project.org/fisheye) [AbstractRestCommand{path='/rest-service-fe/search-v1/crossRepositoryQuery', params={query=PHPCR-21, expand=changesets[0:20].revisions[0:29],reviews}, methodType=GET}] : Received status code 503 (Service Temporarily Unavailable)

          People

          • Assignee:
            David Buchmann
            Reporter:
            Lukas Kahwe
          • Votes:
            1 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: