Update command line options in the export-import documentation #2108

plone/plone.exportimport#112 adds a partial export to plone-exporter. The "Command line utilities" section of docs/admin-guide/export-import.md should describe the new options.

New options

• --path CONTENT_PATH: a content path, relative to the site root. Can be repeated.
• --paths FILE: a file with one content path per line. Empty lines and lines starting with # are ignored.

The two options can be combined.

plone-exporter instance/etc/zope.conf Plone /tmp/plone_data/ --path /news --path /about/team
plone-exporter instance/etc/zope.conf Plone /tmp/plone_data/ --paths paths.txt

Behavior to document

• Each path selects that content and everything inside it.
• Parents are not added: exporting /about/team does not export /about or the site root.
• A path without content is skipped with a warning. If no path has content, or the paths file does not exist, the export aborts.
• Without these options, the whole site is exported, as before.
• In a partial export, the other exported data is limited to the exported content:
  • relations: only when both source and target were exported
  • translations: only exported members; groups left with a single member are dropped
  • discussions and portlets: only on exported content
  • redirects: only those pointing to exported content
  • users and groups: always exported in full

Suggested changes

• Update the plone-exporter usage line, currently plone-exporter [--include-revisions] <path-to-zopeconf> <site-id> <path-to-export-data>.
• Add a subsection with the examples above and the behavior of a partial export.