Skip to content

Update: buildout docs #278

@svx

Description

@svx
Member

Currently we have under http://docs.plone.org/old-reference-manuals/buildout/ some docs about buildout, these docs are outdated.

  • we should update them
  • we should add missing stuff
  • we should find a new place old-reference-manuals will be not included in the docs for Plone 5

Activity

jensens

jensens commented on Jul 14, 2015

@jensens
SponsorMember

the problem is, that the original zc.buildout documentation was and is complete crap, so we did our own. You can not point people to http://www.buildout.org/en/latest/ and also the doctest style pseudo documentation at https://pypi.python.org/pypi/zc.buildout/2.4.0 is even for hardcore pythonistas difficult to read.

so we should update this old home-grown manual.

svx

svx commented on Feb 2, 2017

@svx
MemberAuthor

It is gone in the 5 docs, but still in the 4 docs is that still needed in 5/5.x ?

stevepiercy

stevepiercy commented on Nov 6, 2024

@stevepiercy
Contributor

We have started to migrate the "homegrown version" of buildout docs at https://4.docs.plone.org/old-reference-manuals/buildout/ as mentioned by @jensens into Plone 6 documentation on an "as needed" basis. PR #1746 was part of this effort. There is now a reference to the homegrown version in the Glossary, instead of the poorly structured and written versions from zc.buildout and Buildout.

@petschki @yurj @MrTango @davisagli @mauritsvanrees @gforcada pinging y'all to be aware of this resource, as we continue documenting the use of Buildout in Plone 6 Documentation. Thanks to @polyester for keeping it running!

Closing as completed in #1746 and #1757.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      Participants

      @stevepiercy@jensens@svx

      Issue actions

        Update: buildout docs · Issue #278 · plone/documentation