Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 5 commits into from
Jan 30, 2025
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ build/
.*project
coverage.xml
dist/
docs/_build
__pycache__/
.tox
.vscode/
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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).
2 changes: 0 additions & 2 deletions MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,3 @@ exclude requirements-mxdev.txt
exclude pyvenv.cfg
recursive-exclude frontend *
recursive-exclude .vscode *
recursive-exclude docs/_build *
graft docs
15 changes: 0 additions & 15 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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"
106 changes: 104 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,115 @@
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 focus only on latest Plone and Python.
stevepiercy marked this conversation as resolved.
Show resolved Hide resolved


## 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.
> The following installation instructions are relevant only for Plone 6.0 sites.

Add `plone.exportimport` to the Plone installation using `pip`.
stevepiercy marked this conversation as resolved.
Show resolved Hide resolved

```shell
pip install plone.exportimport
```


### Load the package

To make this package available to a Plone installation, you need to load its ZCML configuration.
stevepiercy marked this conversation as resolved.
Show resolved Hide resolved

If your project has a Python package with custom code, add the following line to your package's `dependencies.zcml` or `configure.zcml`:

```xml
<include package="plone.exportimport" />
```

Alternatively, you can use the `instance.yaml` configuration file provided by [`cookiecutter-zope-instance`](https://github.com/plone/cookiecutter-zope-instance).

Look for the `zcml_package_includes` configuration, and add this package to the list of packages already listed there.

```yaml
zcml_package_includes: ['my.package', '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.
204 changes: 0 additions & 204 deletions docs/Makefile

This file was deleted.

Binary file removed docs/_static/favicon.ico
Binary file not shown.
Loading