Skip to content

Commit

Permalink
[fc] Repository: plone.app.caching
Browse files Browse the repository at this point in the history 
Branch: refs/heads/master
Date: 2020-09-01T17:52:49+02:00
Author: Maurits van Rees (mauritsvanrees) <maurits@vanrees.org>
Commit: plone/plone.app.caching@7b1c8c2

Improved installation documentation.

Remove references to Plone 4.  4.0 even...
This fixes plone/plone.app.caching#38 by improving the documentation.

Files changed:
M README.rst
Repository: plone.app.caching

Branch: refs/heads/master
Date: 2020-09-04T12:37:29+02:00
Author: Gil Forcada Codinachs (gforcada) <gil.gnome@gmail.com>
Commit: plone/plone.app.caching@c878fda

Merge pull request #60 from plone/maurits/readme-install

Improved installation documentation.

Files changed:
M README.rst
  • Loading branch information
@gforcada
gforcada committed Sep 4, 2020
1 parent 2e45c5d commit 22d438c
Showing 1 changed file with 18 additions and 29 deletions.
47 changes: 18 additions & 29 deletions last_commit.txt
View file
Original file line number Diff line number Diff line change
@@ -1,46 +1,35 @@
Repository: plone.app.vocabularies
Repository: plone.app.caching


Branch: refs/heads/master
Date: 2020-09-03T22:36:27+02:00
Date: 2020-09-01T17:52:49+02:00
Author: Maurits van Rees (mauritsvanrees) <maurits@vanrees.org>
Commit: https://github.com/plone/plone.app.vocabularies/commit/e9d23464278302579406123b9ac619874ad540a0
Commit: https://github.com/plone/plone.app.caching/commit/7b1c8c28d9b7aaefe67a6923f8e33e10b2ea42d4

Fixed deprecation warning for zope.site.hooks.
Improved installation documentation.

Remove references to Plone 4. 4.0 even...
This fixes https://github.com/plone/plone.app.caching/issues/38 by improving the documentation.

Files changed:
A news/3130.bugfix
M plone/app/vocabularies/catalog.py
M plone/app/vocabularies/language.py
M plone/app/vocabularies/security.py
M plone/app/vocabularies/skins.py
M plone/app/vocabularies/tests/base.py
M plone/app/vocabularies/types.py
M plone/app/vocabularies/workflow.py
M README.rst

b"diff --git a/news/3130.bugfix b/news/3130.bugfix\nnew file mode 100644\nindex 0000000..5776fd9\n--- /dev/null\n+++ b/news/3130.bugfix\n@@ -0,0 +1 @@\n+Fixed deprecation warning for zope.site.hooks.\ndiff --git a/plone/app/vocabularies/catalog.py b/plone/app/vocabularies/catalog.py\nindex dd06b54..bed8130 100644\n--- a/plone/app/vocabularies/catalog.py\n+++ b/plone/app/vocabularies/catalog.py\n@@ -21,7 +21,7 @@\n from zope.schema.interfaces import IVocabularyFactory\n from zope.schema.vocabulary import SimpleTerm\n from zope.schema.vocabulary import SimpleVocabulary\n-from zope.site.hooks import getSite\n+from zope.component.hooks import getSite\n \n import itertools\n import os\ndiff --git a/plone/app/vocabularies/language.py b/plone/app/vocabularies/language.py\nindex a445414..54648c3 100644\n--- a/plone/app/vocabularies/language.py\n+++ b/plone/app/vocabularies/language.py\n@@ -5,7 +5,7 @@\n from zope.schema.interfaces import IVocabularyFactory\n from zope.schema.vocabulary import SimpleTerm\n from zope.schema.vocabulary import SimpleVocabulary\n-from zope.site.hooks import getSite\n+from zope.component.hooks import getSite\n \n \n @implementer(IVocabularyFactory)\ndiff --git a/plone/app/vocabularies/security.py b/plone/app/vocabularies/security.py\nindex 1fb0fe8..af8e352 100644\n--- a/plone/app/vocabularies/security.py\n+++ b/plone/app/vocabularies/security.py\n@@ -8,7 +8,7 @@\n from zope.schema.interfaces import IVocabularyFactory\n from zope.schema.vocabulary import SimpleTerm\n from zope.schema.vocabulary import SimpleVocabulary\n-from zope.site.hooks import getSite\n+from zope.component.hooks import getSite\n \n import zope.deferredimport\n \ndiff --git a/plone/app/vocabularies/skins.py b/plone/app/vocabularies/skins.py\nindex 604b4e1..c497d5a 100644\n--- a/plone/app/vocabularies/skins.py\n+++ b/plone/app/vocabularies/skins.py\n@@ -5,7 +5,7 @@\n from zope.schema.interfaces import IVocabularyFactory\n from zope.schema.vocabulary import SimpleTerm\n from zope.schema.vocabulary import SimpleVocabulary\n-from zope.site.hooks import getSite\n+from zope.component.hooks import getSite\n \n \n _ = MessageFactory('plone')\ndiff --git a/plone/app/vocabularies/tests/base.py b/plone/app/vocabularies/tests/base.py\nindex 9cb838d..aaec8f6 100644\n--- a/plone/app/vocabularies/tests/base.py\n+++ b/plone/app/vocabularies/tests/base.py\n@@ -3,7 +3,7 @@\n from plone.app.layout.navigation.interfaces import INavigationRoot\n from Products.ZCTextIndex.ParseTree import ParseError\n from zope.interface import implementer\n-from zope.site.hooks import setSite\n+from zope.component.hooks import setSite\n \n \n def create_context():\ndiff --git a/plone/app/vocabularies/types.py b/plone/app/vocabularies/types.py\nindex 2cca30e..b0b0551 100644\n--- a/plone/app/vocabularies/types.py\n+++ b/plone/app/vocabularies/types.py\n@@ -7,7 +7,7 @@\n from zope.schema.interfaces import IVocabularyFactory\n from zope.schema.vocabulary import SimpleTerm\n from zope.schema.vocabulary import SimpleVocabulary\n-from zope.site.hooks import getSite\n+from zope.component.hooks import getSite\n \n \n def getAllowedContentTypes(context):\ndiff --git a/plone/app/vocabularies/workflow.py b/plone/app/vocabularies/workflow.py\nindex d7478c3..198b77a 100644\n--- a/plone/app/vocabularies/workflow.py\n+++ b/plone/app/vocabularies/workflow.py\n@@ -9,7 +9,7 @@\n from zope.schema.interfaces import IVocabularyFactory\n from zope.schema.vocabulary import SimpleTerm\n from zope.schema.vocabulary import SimpleVocabulary\n-from zope.site.hooks import getSite\n+from zope.component.hooks import getSite\n \n \n _ = MessageFactory('plone')\n"
b'diff --git a/README.rst b/README.rst\nindex 86250d2..16a08da 100644\n--- a/README.rst\n+++ b/README.rst\n@@ -8,36 +8,32 @@ Introduction\n ``plone.app.caching`` provides a Plone UI and default rules for managing HTTP response caching in Plone.\n It builds on ``z3c.caching``, ``plone.caching`` and ``plone.cachepurging``.\n \n-``plone.app.caching`` requires Plone 4 or later.\n+``plone.app.caching`` version 2.x requires Plone 5.2 or later.\n+For earlier Plone versions, use a release from branch 1.x.\n+\n \n Installation\n ============\n \n-Plone >=4.1\n------------\n-\n-**From Plone 4.1 onwards, ``plone.app.caching`` is shipped as a dependency of Plone core.**\n-\n-It is available from the Control Panel, but **not enabled by default**.\n-You can enable it from the "add-ons" menu option.\n+``plone.app.caching`` is shipped as a dependency of the ``Plone`` package.\n+Caching is **not enabled by default**.\n+When you create a default Plone site, it is available in the Site Setup.\n+Under the Advanced header, look for the Caching control panel.\n+There you can enable caching.\n \n-Plone 4.0\n----------\n+When the Caching control panel is not there, there can be various reasons for this:\n \n-Add ``plone.app.caching`` to the ``eggs`` list in your ``buildout.cfg``, or as a dependency of one of your own packages in ``setup.py``.\n-ZCML configuration will be automatically loaded via a ``z3c.autoinclude`` entry point.\n-You will also need to install the package in Plone\'s Add-ons control panel as normal.\n+- If your buildout does not load the ``Plone`` egg, but only ``Products.CMFPlone``, then ``plone.app.caching`` is not included.\n+- If the package *is* included, but you add a Plone Site using the advanced form and disable caching, then the control panel is not there.\n \n-This package depends on a number of other packages, including ``z3c.form`` and ``plone.app.registry``, that do not ship with Plone 4.0.\n-You will probably want to lock down the versions for those packages using a known good set.\n-Add this to the the ``extends`` line in your ``buildout.cfg``, *after* the line that includes the Plone KGS::\n+If you want to install it in an existing Plone Site:\n \n- extends =\n- ...\n- http://good-py.appspot.com/release/plone.app.caching/1.0a1\n+1. Make sure the package is available in the Plone instance, by adding ``plone.app.caching`` or ``Plone`` to the eggs and running buildout.\n+2. From the Plone Site Setup go to the ZMI (Zope Management Interface).\n+3. Go to ``portal_setup``, and then to the Import tab.\n+4. Select the HTTP caching support profile, perhaps easiest by id: ``profile-plone.app.caching:default``.\n+5. Click \'Import all steps\'.\n \n-Update the version number at the end of the URL as appropriate.\n-You can find here an `overview of the versions <http://good-py.appspot.com/release/plone.app.caching>`_\n \n Source Code\n ===========\n'

Repository: plone.app.vocabularies
Repository: plone.app.caching


Branch: refs/heads/master
Date: 2020-09-04T12:25:52+02:00
Author: Maurits van Rees (mauritsvanrees) <m.van.rees@zestsoftware.nl>
Commit: https://github.com/plone/plone.app.vocabularies/commit/b3852cb985a4e084acc2bbefba69640f089b5306
Date: 2020-09-04T12:37:29+02:00
Author: Gil Forcada Codinachs (gforcada) <gil.gnome@gmail.com>
Commit: https://github.com/plone/plone.app.caching/commit/c878fda95127485ce39e352322671cc9919ce27f

Merge pull request #63 from plone/maurits/fix-warnings
Merge pull request #60 from plone/maurits/readme-install

Fixed deprecation warning for zope.site.hooks.
Improved installation documentation.

Files changed:
A news/3130.bugfix
M plone/app/vocabularies/catalog.py
M plone/app/vocabularies/language.py
M plone/app/vocabularies/security.py
M plone/app/vocabularies/skins.py
M plone/app/vocabularies/tests/base.py
M plone/app/vocabularies/types.py
M plone/app/vocabularies/workflow.py

b"diff --git a/news/3130.bugfix b/news/3130.bugfix\nnew file mode 100644\nindex 0000000..5776fd9\n--- /dev/null\n+++ b/news/3130.bugfix\n@@ -0,0 +1 @@\n+Fixed deprecation warning for zope.site.hooks.\ndiff --git a/plone/app/vocabularies/catalog.py b/plone/app/vocabularies/catalog.py\nindex dd06b54..bed8130 100644\n--- a/plone/app/vocabularies/catalog.py\n+++ b/plone/app/vocabularies/catalog.py\n@@ -21,7 +21,7 @@\n from zope.schema.interfaces import IVocabularyFactory\n from zope.schema.vocabulary import SimpleTerm\n from zope.schema.vocabulary import SimpleVocabulary\n-from zope.site.hooks import getSite\n+from zope.component.hooks import getSite\n \n import itertools\n import os\ndiff --git a/plone/app/vocabularies/language.py b/plone/app/vocabularies/language.py\nindex a445414..54648c3 100644\n--- a/plone/app/vocabularies/language.py\n+++ b/plone/app/vocabularies/language.py\n@@ -5,7 +5,7 @@\n from zope.schema.interfaces import IVocabularyFactory\n from zope.schema.vocabulary import SimpleTerm\n from zope.schema.vocabulary import SimpleVocabulary\n-from zope.site.hooks import getSite\n+from zope.component.hooks import getSite\n \n \n @implementer(IVocabularyFactory)\ndiff --git a/plone/app/vocabularies/security.py b/plone/app/vocabularies/security.py\nindex 1fb0fe8..af8e352 100644\n--- a/plone/app/vocabularies/security.py\n+++ b/plone/app/vocabularies/security.py\n@@ -8,7 +8,7 @@\n from zope.schema.interfaces import IVocabularyFactory\n from zope.schema.vocabulary import SimpleTerm\n from zope.schema.vocabulary import SimpleVocabulary\n-from zope.site.hooks import getSite\n+from zope.component.hooks import getSite\n \n import zope.deferredimport\n \ndiff --git a/plone/app/vocabularies/skins.py b/plone/app/vocabularies/skins.py\nindex 604b4e1..c497d5a 100644\n--- a/plone/app/vocabularies/skins.py\n+++ b/plone/app/vocabularies/skins.py\n@@ -5,7 +5,7 @@\n from zope.schema.interfaces import IVocabularyFactory\n from zope.schema.vocabulary import SimpleTerm\n from zope.schema.vocabulary import SimpleVocabulary\n-from zope.site.hooks import getSite\n+from zope.component.hooks import getSite\n \n \n _ = MessageFactory('plone')\ndiff --git a/plone/app/vocabularies/tests/base.py b/plone/app/vocabularies/tests/base.py\nindex 9cb838d..aaec8f6 100644\n--- a/plone/app/vocabularies/tests/base.py\n+++ b/plone/app/vocabularies/tests/base.py\n@@ -3,7 +3,7 @@\n from plone.app.layout.navigation.interfaces import INavigationRoot\n from Products.ZCTextIndex.ParseTree import ParseError\n from zope.interface import implementer\n-from zope.site.hooks import setSite\n+from zope.component.hooks import setSite\n \n \n def create_context():\ndiff --git a/plone/app/vocabularies/types.py b/plone/app/vocabularies/types.py\nindex 2cca30e..b0b0551 100644\n--- a/plone/app/vocabularies/types.py\n+++ b/plone/app/vocabularies/types.py\n@@ -7,7 +7,7 @@\n from zope.schema.interfaces import IVocabularyFactory\n from zope.schema.vocabulary import SimpleTerm\n from zope.schema.vocabulary import SimpleVocabulary\n-from zope.site.hooks import getSite\n+from zope.component.hooks import getSite\n \n \n def getAllowedContentTypes(context):\ndiff --git a/plone/app/vocabularies/workflow.py b/plone/app/vocabularies/workflow.py\nindex d7478c3..198b77a 100644\n--- a/plone/app/vocabularies/workflow.py\n+++ b/plone/app/vocabularies/workflow.py\n@@ -9,7 +9,7 @@\n from zope.schema.interfaces import IVocabularyFactory\n from zope.schema.vocabulary import SimpleTerm\n from zope.schema.vocabulary import SimpleVocabulary\n-from zope.site.hooks import getSite\n+from zope.component.hooks import getSite\n \n \n _ = MessageFactory('plone')\n"
M README.rst

b'diff --git a/README.rst b/README.rst\nindex 86250d2..16a08da 100644\n--- a/README.rst\n+++ b/README.rst\n@@ -8,36 +8,32 @@ Introduction\n ``plone.app.caching`` provides a Plone UI and default rules for managing HTTP response caching in Plone.\n It builds on ``z3c.caching``, ``plone.caching`` and ``plone.cachepurging``.\n \n-``plone.app.caching`` requires Plone 4 or later.\n+``plone.app.caching`` version 2.x requires Plone 5.2 or later.\n+For earlier Plone versions, use a release from branch 1.x.\n+\n \n Installation\n ============\n \n-Plone >=4.1\n------------\n-\n-**From Plone 4.1 onwards, ``plone.app.caching`` is shipped as a dependency of Plone core.**\n-\n-It is available from the Control Panel, but **not enabled by default**.\n-You can enable it from the "add-ons" menu option.\n+``plone.app.caching`` is shipped as a dependency of the ``Plone`` package.\n+Caching is **not enabled by default**.\n+When you create a default Plone site, it is available in the Site Setup.\n+Under the Advanced header, look for the Caching control panel.\n+There you can enable caching.\n \n-Plone 4.0\n----------\n+When the Caching control panel is not there, there can be various reasons for this:\n \n-Add ``plone.app.caching`` to the ``eggs`` list in your ``buildout.cfg``, or as a dependency of one of your own packages in ``setup.py``.\n-ZCML configuration will be automatically loaded via a ``z3c.autoinclude`` entry point.\n-You will also need to install the package in Plone\'s Add-ons control panel as normal.\n+- If your buildout does not load the ``Plone`` egg, but only ``Products.CMFPlone``, then ``plone.app.caching`` is not included.\n+- If the package *is* included, but you add a Plone Site using the advanced form and disable caching, then the control panel is not there.\n \n-This package depends on a number of other packages, including ``z3c.form`` and ``plone.app.registry``, that do not ship with Plone 4.0.\n-You will probably want to lock down the versions for those packages using a known good set.\n-Add this to the the ``extends`` line in your ``buildout.cfg``, *after* the line that includes the Plone KGS::\n+If you want to install it in an existing Plone Site:\n \n- extends =\n- ...\n- http://good-py.appspot.com/release/plone.app.caching/1.0a1\n+1. Make sure the package is available in the Plone instance, by adding ``plone.app.caching`` or ``Plone`` to the eggs and running buildout.\n+2. From the Plone Site Setup go to the ZMI (Zope Management Interface).\n+3. Go to ``portal_setup``, and then to the Import tab.\n+4. Select the HTTP caching support profile, perhaps easiest by id: ``profile-plone.app.caching:default``.\n+5. Click \'Import all steps\'.\n \n-Update the version number at the end of the URL as appropriate.\n-You can find here an `overview of the versions <http://good-py.appspot.com/release/plone.app.caching>`_\n \n Source Code\n ===========\n'

0 comments on commit 22d438c

Please sign in to comment.