Browse Source

Plone - update documentation (#1349)

* Update Plone docs
Alin Voinea 7 years ago
parent
commit
57d4b2b366
4 changed files with 113 additions and 59 deletions
  1. 34 13
      plone/content.md
  2. 1 1
      plone/license.md
  3. 77 44
      plone/logo.svg
  4. 1 1
      plone/maintainer.md

+ 34 - 13
plone/content.md

@@ -6,8 +6,9 @@
 
 ## Features
 
--	Images for Plone 5 and Plone 4
+-	Images for Plone 5.x and Plone 4.x
 -	Enable add-ons via environment variables
+-	Choose between [Debian](https://www.debian.org/) or [Alpine](http://www.alpinelinux.org/) based images.
 
 ## Usage
 
@@ -23,17 +24,19 @@ This image includes `EXPOSE 8080` (the Plone port), so standard container linkin
 
 ### Start Plone within a ZEO cluster
 
-Start ZEO server
+ZEO cluster are best suited for production setups, you will **need** a loadbalancer.
+
+Start ZEO server in the background
 
 ```console
-$ docker run --name=zeo %%IMAGE%% zeoserver
+$ docker run --name=zeo %%IMAGE%% zeo
 ```
 
-Start 2 Plone clients
+Start 2 Plone clients (also in the background)
 
 ```console
-$ docker run --link=zeo -e ZEO_ADDRESS=zeo:8100 -p 8081:8080 %%IMAGE%%
-$ docker run --link=zeo -e ZEO_ADDRESS=zeo:8100 -p 8082:8080 %%IMAGE%%
+$ docker run --link=zeo -e ZEO_ADDRESS=zeo:8080 -p 8081:8080 %%IMAGE%%
+$ docker run --link=zeo -e ZEO_ADDRESS=zeo:8080 -p 8082:8080 %%IMAGE%%
 ```
 
 ### Start Plone in debug mode
@@ -46,22 +49,40 @@ $ docker run -p 8080:8080 %%IMAGE%% fg
 
 ### Add-ons
 
-You can enable Plone add-ons via the `PLONE_ADDONS` environment variable
+You can enable Plone add-ons via the `ADDONS` environment variable
 
 ```console
 $ docker run -p 8080:8080 -e PLONE_ADDONS="eea.facetednavigation Products.PloneFormGen" %%IMAGE%%
 ```
 
-For more information on how to extend this image with your own custom settings, adding more add-ons, building it or mounting volumes, please refer to our [documentation](https://github.com/plone/plone.docker/blob/master/docs/usage.rst).
+For more information on how to extend this image with your own custom settings, adding more add-ons, building it or mounting volumes, please refer to our [documentation](https://docs.plone.org/manage/docker/docs/index.html)
 
-### Supported Environment Variables
+## Supported Environment Variables
 
 The Plone image uses several environment variable that allow to specify a more specific setup.
 
--	`PLONE_ADDONS`, `ADDONS` - Customize Plone via Plone add-ons using this environment variable
--	`PLONE_ZCML`, `ZCML` - Include custom Plone add-ons ZCML files
--	`PLONE_DEVELOP`, `DEVELOP` - Develop new or existing Plone add-ons
+### For Basic Usage
+
+-	`ADDONS` - Customize Plone via Plone add-ons using this environment variable
 -	`ZEO_ADDRESS` - This environment variable allows you to run Plone image as a ZEO client.
+
+Run Plone with ZEO and install two addons (PloneFormGen and collective.roster)
+
+```console
+$ docker run --name=instance1 --link=zeo -e ZEO_ADDRESS=zeo:8080 -p 8080:8080 \
+-e ADDONS="Products.PloneFormGen collective.roster" plone
+```
+
+To use specific add-ons versions:
+
+```console
+ -e ADDONS="Products.PloneFormGen==1.8.5 collective.roster==2.3.1"
+```
+
+### For Advanced Usage
+
+-	`PLONE_ZCML`, `ZCML` - Include custom Plone add-ons ZCML files (former `BUILDOUT_ZCML`)
+-	`PLONE_DEVELOP`, `DEVELOP` - Develop new or existing Plone add-ons (former `BUILDOUT_DEVELOP`)
 -	`ZEO_READ_ONLY` - Run Plone as a read-only ZEO client. Defaults to `off`.
 -	`ZEO_CLIENT_READ_ONLY_FALLBACK` - A flag indicating whether a read-only remote storage should be acceptable as a fallback when no writable storages are available. Defaults to `false`.
 -	`ZEO_SHARED_BLOB_DIR` - Set this to on if the ZEO server and the instance have access to the same directory. Defaults to `off`.
@@ -73,7 +94,7 @@ The Plone image uses several environment variable that allow to specify a more s
 
 ## Documentation
 
-Full documentation for end users can be found in the ["docs"](https://github.com/plone/plone.docker/tree/master/docs) folder. It is also available online at http://docs.plone.org/
+Full documentation for end users can be found online at [docs.plone.org](https://docs.plone.org/manage/docker/docs/usage/index.html)
 
 ## Credits
 

+ 1 - 1
plone/license.md

@@ -1 +1 @@
-View [license information](https://plone.org/foundation/copyrights/license-faq) for the software contained in this image.
+View [license information](https://plone.org/foundation/copyright-licensing-logo/license-faq) for the software contained in this image.

+ 77 - 44
plone/logo.svg

@@ -1,46 +1,79 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <!-- Generator: Adobe Illustrator 13.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 14948)  -->
-<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
-<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
-	 width="158.253px" height="40.686px" viewBox="0 0 158.253 40.686" enable-background="new 0 0 158.253 40.686"
-	 xml:space="preserve">
-<path fill="#009DDC" d="M65.228,23.253h-6.589v11.388h-4.393V5.683h10.981c5.653,0,9.271,3.742,9.271,8.785
-	S70.881,23.253,65.228,23.253z M64.983,9.628h-6.345v9.639h6.345c3.05,0,5.124-1.749,5.124-4.799
-	C70.107,11.417,68.033,9.628,64.983,9.628z"/>
-<path fill="#009DDC" d="M83.871,34.641c-3.904,0-5.653-2.644-5.653-5.693V5.683h4.149v23.021c0,1.587,0.567,2.399,2.235,2.399h1.83
-	v3.538H83.871z"/>
-<path fill="#009DDC" d="M104.664,32.444c-1.344,1.384-3.377,2.44-6.184,2.44c-2.805,0-4.799-1.058-6.141-2.44
-	c-1.951-2.032-2.439-4.637-2.439-8.134c0-3.457,0.488-6.061,2.439-8.094c1.342-1.383,3.336-2.44,6.141-2.44
-	c2.807,0,4.84,1.059,6.184,2.44c1.951,2.033,2.439,4.637,2.439,8.094C107.104,27.808,106.615,30.411,104.664,32.444z
-	 M101.531,18.657c-0.773-0.773-1.83-1.181-3.051-1.181c-1.219,0-2.236,0.406-3.01,1.181c-1.26,1.261-1.422,3.416-1.422,5.652
-	s0.162,4.393,1.422,5.653c0.773,0.771,1.791,1.22,3.01,1.22c1.221,0,2.277-0.447,3.051-1.22c1.262-1.262,1.424-3.417,1.424-5.653
-	S102.792,19.918,101.531,18.657z"/>
-<path fill="#009DDC" d="M123.544,34.641V22.073c0-3.214-1.83-4.597-4.147-4.597s-4.271,1.423-4.271,4.597V34.64h-4.147V14.02h4.065
-	v2.074c1.425-1.546,3.416-2.318,5.49-2.318c2.115,0,3.865,0.691,5.084,1.871c1.586,1.545,2.074,3.497,2.074,5.815V34.64
-	L123.544,34.641L123.544,34.641z"/>
-<path fill="#009DDC" d="M135.673,25.531c0,3.537,1.871,5.774,5.246,5.774c2.317,0,3.539-0.649,5.004-2.115l2.643,2.481
-	c-2.115,2.114-4.107,3.213-7.727,3.213c-5.166,0-9.273-2.725-9.273-10.574c0-6.671,3.457-10.534,8.744-10.534
-	c5.531,0,8.744,4.067,8.744,9.925v1.83H135.673z M144.376,19.836c-0.65-1.545-2.113-2.604-4.066-2.604
-	c-1.951,0-3.457,1.059-4.107,2.604c-0.406,0.936-0.488,1.546-0.529,2.807h9.273C144.905,21.382,144.785,20.771,144.376,19.836z"/>
-<circle fill="#009DDC" cx="17.717" cy="11.561" r="4.402"/>
-<path fill="#009DDC" d="M31.069,20.356c0,2.433-1.969,4.401-4.403,4.401c-2.427,0-4.401-1.97-4.401-4.401
-	c0-2.433,1.975-4.401,4.401-4.401C29.101,15.954,31.069,17.924,31.069,20.356z"/>
-<circle fill="#009DDC" cx="17.702" cy="29.176" r="4.402"/>
-<g>
-	<path fill="#009DDC" d="M20.343,0C9.108,0.001,0.001,9.108,0,20.343c0.001,11.234,9.108,20.341,20.343,20.343
-		c11.235-0.002,20.341-9.107,20.343-20.343C40.684,9.108,31.578,0.001,20.343,0z M31.792,31.792
-		c-2.937,2.934-6.972,4.742-11.45,4.743c-4.478-0.001-8.513-1.811-11.45-4.743C5.959,28.855,4.151,24.82,4.15,20.343
-		c0.001-4.478,1.809-8.513,4.743-11.45c2.937-2.934,6.972-4.742,11.45-4.743c4.478,0.001,8.513,1.81,11.45,4.743
-		c2.934,2.938,4.742,6.973,4.743,11.45C36.534,24.82,34.726,28.855,31.792,31.792z"/>
+
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   version="1.1"
+   id="Layer_1"
+   x="0px"
+   y="0px"
+   width="40.686001"
+   height="40.686001"
+   viewBox="0 0 40.685999 40.686"
+   enable-background="new 0 0 158.253 40.686"
+   xml:space="preserve"
+   sodipodi:docname="logo.svg"
+   inkscape:version="0.92.2 2405546, 2018-03-11"><metadata
+   id="metadata3880"><rdf:RDF><cc:Work
+       rdf:about=""><dc:format>image/svg+xml</dc:format><dc:type
+         rdf:resource="http://purl.org/dc/dcmitype/StillImage" /><dc:title></dc:title></cc:Work></rdf:RDF></metadata><defs
+   id="defs3878" /><sodipodi:namedview
+   pagecolor="#ffffff"
+   bordercolor="#666666"
+   borderopacity="1"
+   objecttolerance="10"
+   gridtolerance="10"
+   guidetolerance="10"
+   inkscape:pageopacity="0"
+   inkscape:pageshadow="2"
+   inkscape:window-width="1916"
+   inkscape:window-height="1048"
+   id="namedview3876"
+   showgrid="false"
+   inkscape:snap-page="true"
+   inkscape:zoom="6.5464791"
+   inkscape:cx="69.00927"
+   inkscape:cy="-3.8796729"
+   inkscape:window-x="0"
+   inkscape:window-y="14"
+   inkscape:window-maximized="0"
+   inkscape:current-layer="Layer_1" />
+
+
+
+
+
+<circle
+   cx="17.716999"
+   cy="11.560999"
+   r="4.402"
+   id="circle3857"
+   style="fill:#009ddc" />
+<path
+   d="m 31.069,20.355999 c 0,2.433 -1.969,4.401 -4.403,4.401 -2.427,0 -4.401,-1.97 -4.401,-4.401 0,-2.433 1.975,-4.401 4.401,-4.401 2.435,-0.001 4.403,1.969 4.403,4.401 z"
+   id="path3859"
+   inkscape:connector-curvature="0"
+   style="fill:#009ddc" />
+<circle
+   cx="17.702"
+   cy="29.176001"
+   r="4.402"
+   id="circle3861"
+   style="fill:#009ddc" />
+<g
+   id="g3865">
+	<path
+   d="M 20.343,0 C 9.108,0.001 0.001,9.108 0,20.343 0.001,31.577 9.108,40.684 20.343,40.686 31.578,40.684 40.684,31.579 40.686,20.343 40.684,9.108 31.578,0.001 20.343,0 Z M 31.792,31.792 C 28.855,34.726 24.82,36.534 20.342,36.535 15.864,36.534 11.829,34.724 8.892,31.792 5.959,28.855 4.151,24.82 4.15,20.343 4.151,15.865 5.959,11.83 8.893,8.893 11.83,5.959 15.865,4.151 20.343,4.15 c 4.478,10e-4 8.513,1.81 11.45,4.743 2.934,2.938 4.742,6.973 4.743,11.45 -0.002,4.477 -1.81,8.512 -4.744,11.449 z"
+   id="path3863"
+   inkscape:connector-curvature="0"
+   style="fill:#009ddc" />
 </g>
-<g>
-	<path fill="#009DDC" d="M156.082,13.786c-1.195,0-2.164,0.971-2.164,2.168c0.002,1.197,0.969,2.168,2.164,2.168
-		c1.199,0,2.172-0.971,2.172-2.168S157.281,13.786,156.082,13.786z M156.082,17.804c-1.021-0.002-1.846-0.827-1.846-1.85
-		c0.002-1.021,0.825-1.849,1.846-1.851c1.023,0.002,1.852,0.828,1.854,1.851C157.933,16.977,157.105,17.802,156.082,17.804z"/>
-</g>
-<g>
-	<path fill="#009DDC" d="M156.604,17.245l-0.54-1.08h-0.486v1.08h-0.389v-2.564h0.994c0.484,0,0.796,0.313,0.796,0.75
-		c0,0.367-0.224,0.602-0.513,0.68l0.592,1.136L156.604,17.245L156.604,17.245z M156.153,15.031h-0.575v0.803h0.575
-		c0.261,0,0.437-0.147,0.437-0.399S156.414,15.031,156.153,15.031z"/>
-</g>
-</svg>
+
+
+</svg>

+ 1 - 1
plone/maintainer.md

@@ -1 +1 @@
-[the Plone Foundation](%%GITHUB-REPO%%)
+[Plone Community](%%GITHUB-REPO%%)