Skip to content

Commit

Permalink
Added instructions how developer.plone.org builds are done
Browse files Browse the repository at this point in the history
  • Loading branch information
miohtama committed Oct 16, 2012
1 parent cf2d921 commit 77908d0
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 4 deletions.
2 changes: 1 addition & 1 deletion doc-holliday.sh
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# #




deploy_target=/tmp/test-deploy deploy_target=/var/www/developer.plone.org/var/public_html


# http://stackoverflow.com/questions/3258243/git-check-if-pull-needed # http://stackoverflow.com/questions/3258243/git-check-if-pull-needed
git pull | grep -q -v 'Already up-to-date.' && changed=1 git pull | grep -q -v 'Already up-to-date.' && changed=1
Expand Down
35 changes: 33 additions & 2 deletions source/reference_manuals/active/writing/crosslinking.rst
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ collective.developermanual has a section *Reference manuals*


* Manuals will be hosted under *developers.plone.org* domain * Manuals will be hosted under *developers.plone.org* domain


Benefits of having the documentation in developers.plone.org Benefits of having the documentation in developer.plone.org
================================================================ ================================================================


The main benefit of having your manual in *developers.plone.org* The main benefit of having your manual in *developers.plone.org*
Expand Down Expand Up @@ -76,4 +76,35 @@ See that your manual gets correctly added in the index::
``conf.py`` creates symlinks in ``source/reference_manuals/external``. If you manage ``conf.py`` creates symlinks in ``source/reference_manuals/external``. If you manage
to mess them reset the situation with the command:: to mess them reset the situation with the command::


rm source/reference_manuals/external/* rm source/reference_manuals/external/*

developer.plone.org builds
================================================

``developer.plone.org`` documentation builds are
done on *deus2.plone.org* machine in ``/var/www/developer.plone.org``
folder. They are done by running
`doc-holliday.sh update script <https://github.com/collective/collective.developermanual/blob/master/doc-holliday.sh>`_ in a crontab created by *deployment.cfg*.

We are looking forward to get our documentation hosted back to *readthedocs.org*, but currently *readthedocs.org*
do not have buildout support needed in our use case. In any case the docs are plain HTML files.

The deployment is done as following::

sudo -i
mkdir /var/www/developer.plone.org
chown apache:apache
/var/www/developer.plone.org
cd /var/www
sudo -u apache git clone git://github.com/collective/collective.developermanual.git developer.plone.org
cd developer.plone.org
sudo -u apache python bootstrap.py
sudo -u apache bin/buildout -c deployment.cfg

The folder where final static HTML files lie is ``/var/www/developer.plone.org/var/public_html``.






2 changes: 1 addition & 1 deletion source/reference_manuals/active/writing/nursinghome.rst
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ for documentation which is no longer under active maintenance.


This includes This includes


* Old content from plone.org * Old content from plone.org which has been migrated to Sphinx format


* Content from Plone Developer Documentation where the documentation * Content from Plone Developer Documentation where the documentation
team feels it no longer reflects the modern Plone versions team feels it no longer reflects the modern Plone versions
Expand Down

0 comments on commit 77908d0

Please sign in to comment.