Skip to content

Commit 628f84e

Browse files
jensensclaude
andcommitted
Use sentence case for all Sphinx documentation headings
Align heading style with Plone documentation style guide which follows the Microsoft Writing Style Guide: only capitalize the first word and proper nouns in headings. Affects 26 files across tutorials, how-to guides, reference, and explanation sections. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent b1efaab commit 628f84e

26 files changed

Lines changed: 84 additions & 84 deletions

docs/sources/explanation/blob-handling.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# How Blob Storage Works
1+
# How blob storage works
22

33
<!-- diataxis: explanation -->
44

@@ -91,7 +91,7 @@ blobs to S3-compatible object storage:
9191
- Blobs exceeding the threshold are uploaded to S3
9292
- A local cache directory avoids repeated S3 downloads
9393

94-
## S3 Blob Wrapper (z3blobs)
94+
## S3 blob wrapper (z3blobs)
9595

9696
The `zodb-s3blobs` wrapper can be applied to `direct`, `relstorage`, or `zeo`
9797
to redirect all blob operations to S3-compatible object storage. When enabled:

docs/sources/explanation/storage-backends.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Understanding Storage Backends
1+
# Understanding storage backends
22

33
<!-- diataxis: explanation -->
44

@@ -65,7 +65,7 @@ preservation.
6565
cached locally) or *shared* mode (blobs on a shared filesystem)
6666
- History-free mode gives better performance but disables ZODB-level undo
6767

68-
## ZEO (Zope Enterprise Objects)
68+
## ZEO (Zope enterprise objects)
6969

7070
[ZEO](https://zeo.readthedocs.io/) is the original client-server protocol
7171
for ZODB. A dedicated ZEO server process manages the filestorage, and
@@ -123,7 +123,7 @@ storage for large blob volumes.
123123
- Newer and less battle-tested than RelStorage or ZEO
124124
- Blob handling is fundamentally different from the other backends
125125

126-
## S3 Blob Wrapper (z3blobs)
126+
## S3 blob wrapper (z3blobs)
127127

128128
[zodb-s3blobs](https://pypi.org/project/zodb-s3blobs/) is not a fifth storage
129129
backend but a **wrapper** that can be applied to any of the first three backends

docs/sources/explanation/why-cookiecutter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Why Cookiecutter for Zope Configuration?
1+
# Why Cookiecutter for Zope configuration?
22

33
<!-- diataxis: explanation -->
44

docs/sources/how-to/configure-cors.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Configure CORS for REST API Access
1+
# Configure CORS for REST API access
22

33
<!-- diataxis: how-to -->
44

@@ -10,7 +10,7 @@ CORS support is provided by
1010
[plone.rest](https://pypi.org/project/plone.rest/) and is configured through
1111
`cookiecutter-zope-instance` settings.
1212

13-
## Step 1: Enable CORS
13+
## Step 1: enable CORS
1414

1515
By default, CORS is disabled. Enable it in your `instance.yaml`:
1616

@@ -19,7 +19,7 @@ default_context:
1919
cors_enabled: true
2020
```
2121
22-
## Step 2: Configure allowed origins
22+
## Step 2: configure allowed origins
2323
2424
Specify which origins may access your Plone site:
2525
@@ -71,7 +71,7 @@ The default value for `cors_allow_origin` is already
7171
you only need to set `cors_enabled: true`.
7272
```
7373
74-
## Example: Production with specific domains
74+
## Example: production with specific domains
7575
7676
```yaml
7777
default_context:

docs/sources/how-to/configure-pgjsonb.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Configure PGJsonb Storage
1+
# Configure PGJsonb storage
22

33
<!-- diataxis: how-to -->
44

@@ -12,7 +12,7 @@ standard SQL operators.
1212
- The `zodb-pgjsonb` and `zodb-json-codec` Python packages installed
1313
- A PostgreSQL database created for your Zope instance
1414

15-
## Step 1: Set the storage type
15+
## Step 1: set the storage type
1616

1717
In your `instance.yaml`, set the storage backend to `pgjsonb`:
1818

@@ -21,7 +21,7 @@ default_context:
2121
db_storage: pgjsonb
2222
```
2323
24-
## Step 2: Configure the connection string
24+
## Step 2: configure the connection string
2525
2626
Provide the PostgreSQL DSN so the storage can connect to your database:
2727
@@ -38,7 +38,7 @@ default_context:
3838
db_pgjsonb_dsn: "postgresql://zodb:zodb@localhost:5433/zodb"
3939
```
4040
41-
## Step 3: Choose history mode
41+
## Step 3: choose history mode
4242
4343
By default, PGJsonb uses a history-free schema (no undo, better performance).
4444
To enable ZODB-level undo support:

docs/sources/how-to/configure-relstorage.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ horizontal scaling.
1313
- The `RelStorage` and `psycopg2` Python packages installed
1414
- A PostgreSQL database created for your Zope instance
1515

16-
## Step 1: Set the storage type
16+
## Step 1: set the storage type
1717

1818
In your `instance.yaml`, set the storage backend to `relstorage`:
1919

@@ -22,7 +22,7 @@ default_context:
2222
db_storage: relstorage
2323
```
2424
25-
## Step 2: Set the blob mode
25+
## Step 2: set the blob mode
2626
2727
RelStorage stores blobs in the database. Your Zope client needs a local cache
2828
directory for blob data. Set the blob mode to `cache`:
@@ -38,7 +38,7 @@ You **must** set `db_blob_mode` to `cache` when using RelStorage.
3838
The default value `shared` is only appropriate for direct filestorage.
3939
```
4040

41-
## Step 3: Choose the database backend
41+
## Step 3: choose the database backend
4242

4343
Set the relational database type. PostgreSQL is the recommended choice:
4444

@@ -51,7 +51,7 @@ default_context:
5151
5252
Other supported values are `mysql`, `oracle`, and `sqlite3`.
5353

54-
## Step 4: Configure the connection string
54+
## Step 4: configure the connection string
5555

5656
Provide the PostgreSQL DSN (Data Source Name) so RelStorage can connect to
5757
your database:

docs/sources/how-to/configure-z3blobs.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Configure S3 Blob Storage (z3blobs)
1+
# Configure S3 blob storage (z3blobs)
22

33
<!-- diataxis: how-to -->
44

@@ -11,7 +11,7 @@ This guide walks you through enabling S3-backed blob storage using
1111
- An S3-compatible storage service (AWS S3, MinIO, Ceph, etc.)
1212
- A bucket created for your blob data
1313

14-
## Step 1: Enable the wrapper
14+
## Step 1: enable the wrapper
1515

1616
In your `instance.yaml`, enable the z3blobs wrapper alongside your existing
1717
storage backend:
@@ -22,7 +22,7 @@ default_context:
2222
db_z3blobs_enabled: true
2323
```
2424
25-
## Step 2: Configure the S3 bucket
25+
## Step 2: configure the S3 bucket
2626
2727
Provide the bucket name and a local cache directory:
2828
@@ -34,7 +34,7 @@ default_context:
3434
db_z3blobs_cache_dir: var/s3cache
3535
```
3636
37-
## Step 3: Configure S3 connection (if not AWS)
37+
## Step 3: configure S3 connection (if not AWS)
3838
3939
For MinIO or other S3-compatible stores, set the endpoint URL and credentials:
4040

docs/sources/how-to/configure-zeo.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Configure ZEO Client
1+
# Configure ZEO client
22

33
<!-- diataxis: how-to -->
44

@@ -11,7 +11,7 @@ Zope application processes to share a single database.
1111
- A running ZEO server (see ZODB/ZEO documentation for server setup)
1212
- The `ZEO` Python package installed
1313

14-
## Step 1: Set the storage type
14+
## Step 1: set the storage type
1515

1616
In your `instance.yaml`, set the storage backend to `zeo`:
1717

@@ -20,7 +20,7 @@ default_context:
2020
db_storage: zeo
2121
```
2222
23-
## Step 2: Configure the server address
23+
## Step 2: configure the server address
2424
2525
Tell the client where to find the ZEO server:
2626
@@ -37,7 +37,7 @@ default_context:
3737
db_zeo_server: "primary.example.com:8100 secondary.example.com:8100"
3838
```
3939
40-
## Step 3: Configure blob storage
40+
## Step 3: configure blob storage
4141
4242
For ZEO, shared blob storage is recommended. All ZEO clients and the ZEO
4343
server share a common blob directory (which may be on a network filesystem
@@ -61,7 +61,7 @@ default_context:
6161
db_blob_cache_size: 10737418240 # 10 GB
6262
```
6363
64-
## Optional: Enable persistent client cache
64+
## Optional: enable persistent client cache
6565
6666
To persist the cache across restarts (reducing startup time and ZEO server
6767
load), set a client name:

docs/sources/how-to/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
# How-To Guides
1+
# How-to guides
22

33
<!-- diataxis: how-to -->
44

55
Goal-oriented guides for common tasks.
66

7-
## Database Backends
7+
## Database backends
88

99
- {doc}`configure-relstorage`
1010
- {doc}`configure-pgjsonb`
1111
- {doc}`configure-zeo`
1212
- {doc}`configure-z3blobs`
1313

14-
## Storage Migration
14+
## Storage migration
1515

1616
- {doc}`migrate-storage`
1717

18-
## Web Layer
18+
## Web layer
1919

2020
- {doc}`configure-cors`
2121

docs/sources/how-to/migrate-storage.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Migrate Data Between Storage Backends
1+
# Migrate data between storage backends
22

33
<!-- diataxis: how-to -->
44

@@ -12,15 +12,15 @@ using the generic [zodb-convert](https://pypi.org/project/zodb-convert/) tool.
1212
(e.g. `ZODB` for filestorage, `RelStorage` for relstorage, `zodb-pgjsonb`
1313
for pgjsonb)
1414

15-
## Approach 1: Generated configuration files
15+
## Approach 1: generated configuration files
1616

1717
When your instance uses a non-filestorage backend (RelStorage, PGJsonb, or
1818
ZEO), the cookiecutter generates `convert-import.conf` and
1919
`convert-export.conf` files in the `etc/` directory. These are ready-made
2020
configuration files for `zodb-convert` that convert between your configured
2121
backend and a FileStorage.
2222

23-
### Step 1: Set the conversion paths
23+
### Step 1: set the conversion paths
2424

2525
In your `instance.yaml`, provide the FileStorage paths for the "other side"
2626
of the conversion:
@@ -39,29 +39,29 @@ default_context:
3939
4040
These settings work with all non-filestorage backends.
4141
42-
### Step 2: Import data from FileStorage
42+
### Step 2: import data from FileStorage
4343
4444
Place your `Data.fs` and blobs at the import locations, then run:
4545

4646
```bash
4747
zodb-convert etc/convert-import.conf
4848
```
4949

50-
### Step 3: Export data to FileStorage
50+
### Step 3: export data to FileStorage
5151

5252
To create a portable FileStorage backup:
5353

5454
```bash
5555
zodb-convert etc/convert-export.conf
5656
```
5757

58-
## Approach 2: Using existing zope.conf files
58+
## Approach 2: using existing zope.conf files
5959

6060
If you have two Zope instances with different storage backends, `zodb-convert`
6161
can read storage configuration directly from their `zope.conf` files. No
6262
extra configuration files are needed.
6363

64-
### Step 1: Generate the destination instance
64+
### Step 1: generate the destination instance
6565

6666
Create a second instance configured for the new storage backend:
6767

@@ -79,7 +79,7 @@ cookiecutter -f --no-input --config-file instance-new.yaml \
7979
gh:plone/cookiecutter-zope-instance
8080
```
8181

82-
### Step 2: Run the conversion
82+
### Step 2: run the conversion
8383

8484
```bash
8585
zodb-convert \

0 commit comments

Comments
 (0)