diff --git a/README.rst b/README.rst index 147225e2..fbbf6050 100644 --- a/README.rst +++ b/README.rst @@ -1,19 +1,19 @@ -.. This README is meant for consumption by humans and pypi. Pypi can render rst files so please do not use Sphinx features. - If you want to learn more about writing documentation, please check out: http://docs.plone.org/about/documentation_styleguide.html - This text does not appear on pypi or github. It is a comment. +.. This README is meant for consumption by humans and PyPI. PyPI can render reStructuredText files, so please do not use Sphinx features. + If you want to learn more about writing documentation, please check out: https://6.docs.plone.org/contributing/documentation/ + This text does not appear on PyPI or GitHub. It is a comment. .. image:: https://img.shields.io/pypi/v/collective.exportimport.svg - :target: https://pypi.python.org/pypi/collective.exportimport/ + :target: https://pypi.org/project/collective.exportimport/ :alt: Latest Version .. image:: https://img.shields.io/pypi/status/collective.exportimport.svg - :target: https://pypi.python.org/pypi/collective.exportimport + :target: https://pypi.org/project/collective.exportimport/ :alt: Egg Status .. image:: https://img.shields.io/pypi/pyversions/collective.exportimport.svg?style=plastic :alt: Supported - Python Versions .. image:: https://img.shields.io/pypi/l/collective.exportimport.svg - :target: https://pypi.python.org/pypi/collective.exportimport/ + :target: https://pypi.org/project/collective.exportimport/ :alt: License @@ -126,7 +126,7 @@ Use-cases Migrations ---------- -When a in-place-migration is not required you can choose this addon to migrate the most important parts of your site to json and then import it into a new Plone instance of your targeted version: +When a in-place-migration is not required you can choose this add-on to migrate the most important parts of your site to json and then import it into a new Plone instance of your targeted version: * Export content from a Plone site (it supports Plone 4 and 5, Archetypes and Dexterity, Python 2 and 3). * Import the exported content into a new site (Plone 5.2+, Dexterity, Python 3) @@ -137,15 +137,14 @@ How to migrate additional features like Annotations or Marker Interfaces is disc Other ----- -You can use this addon to +You can use this add-on to -* Archive your content as json -* Export data to prepare a migration to another system +* Archive your content as JSON. +* Export data to prepare a migration to another system. * Combine content from multiple plone-sites into one. * Import a plone-site as a subsite into another. * Import content from other systems as long as it fits the required format. -* Update or replace existing data -* ... +* Update or replace existing data. Details ======= @@ -272,7 +271,7 @@ In the import-form you can manually select a directory on the server or specify Customize export and import =========================== -This addon is designed to be adapted to your requirements and has multiple hooks to make that easy. +This add-on is designed to be adapted to your requirements and has multiple hooks to make that easy. To make that easier here are packages you can reuse to override and extend the export and import. Use these templates and adapt them to your own projects: @@ -341,9 +340,9 @@ Export Example return item -Register it with your own browserlayer to override the default: +Register it with your own browserlayer to override the default. -.. code-block:: xml +.. code-block::