Skip to content

Commit

Permalink
minor doc polishing
Browse files Browse the repository at this point in the history
  • Loading branch information
jensens committed Jul 1, 2024
1 parent f25eba2 commit 9e4c1d5
Show file tree
Hide file tree
Showing 8 changed files with 15 additions and 13 deletions.
14 changes: 8 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ It bakes configuration for Zope 5
Features
========

- Creates basic file-system structure with ``zope.conf``, ``zope.ini``, ``site.zcml`` and inital user.
- Creates basic file-system structure with ``zope.conf``, ``zope.ini``, ``site.zcml`` and initial user.
- Set Zope's main configuration options.
- Configure different database backends such as local file-system storage, ``RelStorage`` or ``ZEO``.
- Enable development options.
Expand Down Expand Up @@ -68,7 +68,7 @@ Base Locations
The target directory name of the cookiecutter generated configuration.
This is also the so called *INSTANCEHOME*.

Attention, this is relative to current directory or to cookiecutters command line options if given (``-o PATH`` or ``--output-dir PATH``).
Attention, this is relative to current directory or to cookiecutter command line options if given (``-o PATH`` or ``--output-dir PATH``).

Default: ``instance``

Expand Down Expand Up @@ -240,7 +240,7 @@ Zope/Plone offers different ZODB storage backends for different environments and
- For development a simple local file based *direct* storage is all you need (aka filestorage).
- As soon as you want multiple application processes of Zope/Plone (horizontal scaling) you need to run a separate database server process and connect to it.

- We recommend to use a Postgresql database using the *RelStorage* implementation for ZODB with *psycopg2* driver as database server in production environments.
- We recommend to use a PostgreSQL database using the *RelStorage* implementation for ZODB with *psycopg2* driver as database server in production environments.
RelStorage supports very well MySQL (and derivatives), Oracle and SQLite 3 as database servers.
- Zope and ZODB comes with *ZEO* (Zope Enterprise Objects). This more lightweight storage server is supported here too. It is widely used in production environment.

Expand Down Expand Up @@ -526,14 +526,16 @@ The configuration for the scripts is generated as separate file:
The file ``relstorage-pack.conf`` for the command line utility ``zobdpack`` is always generated for all RelStorage configurations.
For usage information read `Packing Or Reference Checking A ZODB Storage: zodbpack <https://relstorage.readthedocs.io/en/latest/zodbpack.html>`_.

The file ``relstorage-export.conf`` is generated if the two ``db_relstorage_export_*`` settings are given.
The file ``relstorage-import.conf`` is generated if the two ``db_relstorage_import_*`` settings are given.
The files
- ``relstorage-export.conf`` is generated if the two ``db_relstorage_export_*`` settings are given, and
- ``relstorage-import.conf`` is generated if the two ``db_relstorage_import_*`` settings are given.

Both are for the command line utility ``zobdconvert``.
For usage information read `Copying Data Between ZODB Storages: zodbconvert <https://relstorage.readthedocs.io/en/latest/zodbconvert.html>`_

At the moment only the filestorage with blobs is supported.
In future there may be more options, like converting from/to a ZEO-server or another RelStorage/Database.
Latter would be useful to upgrade a database or convert MyQL to Postgresql or vice versa.
Latter would be useful to upgrade a database or convert MySQL to PostgreSQL or vice versa.

``db_relstorage_import_filestorage_location``
The filename of the filestorage to import from.
Expand Down
2 changes: 1 addition & 1 deletion {{ cookiecutter.target }}/etc/cors.zcml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
/>

<!--
This file is generated by cookiecutter-zope-instance {{ cookiecutter._version }}.
This file was generated by cookiecutter-zope-instance {{ cookiecutter._version }}.
for details follow https://github.com/plone/cookiecutter-zope-instance
-->

Expand Down
2 changes: 1 addition & 1 deletion {{ cookiecutter.target }}/etc/relstorage-export.conf
Original file line number Diff line number Diff line change
Expand Up @@ -55,5 +55,5 @@
# !!! Missing db_relstorage_export_* settings!
{%- endif %}

# This file is generated by cookiecutter-zope-instance {{ cookiecutter._version }}.
# This file was generated by cookiecutter-zope-instance {{ cookiecutter._version }}.
# for details follow https://github.com/plone/cookiecutter-zope-instance
2 changes: 1 addition & 1 deletion {{ cookiecutter.target }}/etc/relstorage-import.conf
Original file line number Diff line number Diff line change
Expand Up @@ -54,5 +54,5 @@
# !!! Missing db_relstorage_export_* settings!
{%- endif %}

# This file is generated by cookiecutter-zope-instance {{ cookiecutter._version }}.
# This file was generated by cookiecutter-zope-instance {{ cookiecutter._version }}.
# for details follow https://github.com/plone/cookiecutter-zope-instance
2 changes: 1 addition & 1 deletion {{ cookiecutter.target }}/etc/relstorage-pack.conf
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,5 @@
# No RelStorage configured
{%- endif %}

# This file is generated by cookiecutter-zope-instance {{ cookiecutter._version }}.
# This file was generated by cookiecutter-zope-instance {{ cookiecutter._version }}.
# for details follow https://github.com/plone/cookiecutter-zope-instance
2 changes: 1 addition & 1 deletion {{ cookiecutter.target }}/etc/site.zcml
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@
<securityPolicy component="AccessControl.security.SecurityPolicy" />

<!--
This file is generated by cookiecutter-zope-instance {{ cookiecutter._version }}.
This file was generated by cookiecutter-zope-instance {{ cookiecutter._version }}.
for details follow https://github.com/plone/cookiecutter-zope-instance
-->
</configure>
2 changes: 1 addition & 1 deletion {{ cookiecutter.target }}/etc/zope.conf
Original file line number Diff line number Diff line change
Expand Up @@ -118,5 +118,5 @@ default-zpublisher-encoding utf-8
{%- endif %}
</zodb_db>

# This file is generated by cookiecutter-zope-instance {{ cookiecutter._version }}.
# This file was generated by cookiecutter-zope-instance {{ cookiecutter._version }}.
# for details follow https://github.com/plone/cookiecutter-zope-instance
2 changes: 1 addition & 1 deletion {{ cookiecutter.target }}/etc/zope.ini
Original file line number Diff line number Diff line change
Expand Up @@ -99,5 +99,5 @@ format = %(asctime)s %(levelname)-7.7s [%(name)s:%(lineno)s][%(threadName)s] %(m
[formatter_message]
format = %(message)s

# This file is generated by cookiecutter-zope-instance {{ cookiecutter._version }}.
# This file was generated by cookiecutter-zope-instance {{ cookiecutter._version }}.
# for details follow https://github.com/plone/cookiecutter-zope-instance

0 comments on commit 9e4c1d5

Please sign in to comment.