Merge pull request #47 from plone/migrate-docs-46

Migrate plone.exportimport documentation from its docs to its README.md and to Plone 6 Documenation

.gitignore

@@ -15,7 +15,6 @@ build/
 .*project
 coverage.xml
 dist/
-docs/_build
 __pycache__/
 .tox
 .vscode/

CONTRIBUTING.md

@@ -1 +1 @@
-Please see [Developer Guidelines](https://docs.plone.org/develop/coredev/docs/guidelines.html)
+Please see [Contributing](https://github.com/plone/plone.exportimport/?tab=readme-ov-file#Contributing).

MANIFEST.in

@@ -11,5 +11,3 @@ exclude requirements-mxdev.txt
 exclude pyvenv.cfg
 recursive-exclude frontend *
 recursive-exclude .vscode *
-recursive-exclude docs/_build *
-graft docs

Makefile

@@ -119,18 +119,3 @@ test: bin/tox ## run tests
 .PHONY: test-coverage
 test-coverage: bin/tox ## run tests with coverage
 	bin/tox -e coverage
-
-# Docs
-bin/sphinx-build: bin/pip
-	bin/pip install -r requirements-docs.txt
-
-.PHONY: build-docs
-build-docs: bin/sphinx-build  ## Build the documentation
-	./bin/sphinx-build \
-		-b html $(DOCS_DIR) "$(DOCS_DIR)/_build/html"
-
-.PHONY: livehtml
-livehtml: bin/sphinx-build  ## Rebuild Sphinx documentation on changes, with live-reload in the browser
-	./bin/sphinx-autobuild \
-		--ignore "*.swp" \
-		-b html $(DOCS_DIR) "$(DOCS_DIR)/_build/html"

README.md

@@ -6,13 +6,95 @@
   Plone Content Export and Import
 </h1>
 
-Package supporting the export and import of content, principals, relations, and translations from and to a Plone site.
+Package supporting the export and import of content, principals, relations, translations, discussions, and redirects from and to a Plone site.
 
 ## Introduction
 
 This package is a slimmer version of the awesome [collective.exportimport](https://github.com/collective/collective.exportimport).
 
-While `collective.exportimport` supports older Plone versions and Python 2, and also takes care of data conversion -- i.e.: from Archetypes to Dexterity -- this package focus only on latest Plone and Python.
+While `collective.exportimport` supports older Plone versions and Python 2, and also takes care of data conversion from Archetypes to Dexterity, this package focuses only on latest Plone and Python.
+
+
+## Documentation
+
+[`plone.exportimport` documentation](https://6.docs.plone.org/admin-guide/export-import.html)
+
+
+
+## Installation
+
+> [!IMPORTANT]
+> This package supports sites running Plone version 6.0 and above.
+
+> [!IMPORTANT]
+> This package is now included with Plone 6.1 and above by default.
+
+If `plone.exportimport` is not yet available in your Plone installation, add it using `pip`.
+
+```shell
+pip install plone.exportimport
+```
+
+
+## Contributing
+
+See [Contributing to Plone](https://6.docs.plone.org/contributing/index.html) and [Contribute to Plone 6 core](Contribute to Plone 6 core) for general contributing policies and guidance.
+
+The following sections specifically describe how to develop and contribute to `plone.exportimport`.
+
+
+### Setup
+
+You need a working Python environment version 3.8 or later.
+
+Install the dependencies and a development instance using the following command.
+
+```shell
+make install
+```
+
+
+### Local environment Plone server
+
+Start Plone, on port 8080, with the following command.
+
+```shell
+make start
+```
+
+
+### Format code base
+
+Format the code base with the following command.
+
+```shell
+make format
+```
+
+
+### Run tests
+
+Testing of this package is done with [`pytest`](https://docs.pytest.org/en/stable/) and [`tox`](https://tox.wiki/en/stable/).
+
+Run all tests with the following command.
+
+```shell
+make test
+```
+
+Run all tests, but stop on the first error and open a `pdb` session.
+
+```shell
+./bin/tox -e test -- -x --pdb
+```
+
+Run tests named `TestUtilsDiscussions`.
+
+```shell
+./bin/tox -e test -- -k TestUtilsDiscussions
+```
+
 
 ## License
+
 The project is licensed under the GPLv2.