Skip to content

Commit c256013

Browse files
committed
docs: align spelling to US English and highlight config inheritance
Convert UK spellings across docs and ADRs to US forms and update the spelling wordlist accordingly. Add a “Why teams use it” bullet on the What is page for centralized framework configuration inheritance at runtime.
1 parent 2d2a608 commit c256013

27 files changed

Lines changed: 59 additions & 58 deletions

docs/decisions/0001-bundle-src-layout.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ modules and lifecycle scripts. This caused:
1313

1414
- No separation between "code that gets installed on the cluster" and "code that spec
1515
references by module path".
16-
- No clear, fork-safe area for customer customisation.
16+
- No clear, fork-safe area for customer customization.
1717
- Ambiguity between `extensions/` (sys.path) and `extensions/libraries/` (a variant
1818
that was never released to `main`).
1919

@@ -69,6 +69,6 @@ user-facing documentation to avoid confusion with callback-registration APIs.
6969
code. It is **not** required if libraries are sourced from PyPI, UC Volumes, or an
7070
artifact repository.
7171
- New bundles should place spec-referenced Python in `src/python/` and cluster-install
72-
artefacts in `src/libraries/` (if bundled).
72+
artifacts in `src/libraries/` (if bundled).
7373
- The `pipeline_bundle_template/` and samples are migrated to this layout in this PR.
7474
- Existing bundles using `extensions/` continue to work until `v1.0.0` (see ADR-0002).

docs/decisions/0002-extensions-deprecation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@ The new canonical path (`src/python/`) was introduced in ADR-0001.
2222

2323
## Decision
2424

25-
| Legacy behaviour | Released? | Action in v0.13.0 | Removed in |
25+
| Legacy behavior | Released? | Action in v0.13.0 | Removed in |
2626
|-----------------|-----------|-----------------|------------|
2727
| Flat `extensions/` on `sys.path` | Yes | Emit `DeprecationWarning` + structured log | **v1.0.0** |
2828
| `extensions/libraries/` on `sys.path` | No | Drop immediately, no deprecation window | **v0.13.0** (this PR) |
2929

30-
**One-minor deprecation window:** deprecated behaviour is removed in the first minor
30+
**One-minor deprecation window:** deprecated behavior is removed in the first minor
3131
version after the deprecation warning lands — giving consumers one release cycle to
3232
migrate before the path disappears.
3333

docs/decisions/0004-mirror-to-stdout-default.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ default logger is returned unchanged.
6262
- The `lakeflowframework` `logging.Logger` instance is modified in-place when
6363
silenced. Any code that obtained a direct `logging.getLogger("lakeflowframework")`
6464
reference before logger resolution will stop producing output — this is the
65-
intended behaviour.
65+
intended behavior.
6666
- `mirror_to_stdout: false` is the breaking change relative to the previous
6767
hard-coded stdout logger. Teams relying on plain-text stdout output and also
6868
enabling a custom logger must set `mirror_to_stdout: true` explicitly.

docs/decisions/0005-syspath-registration-decoupled-from-logger.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ADR-0005: `sys.path` registration decoupled from logger initialisation
1+
# ADR-0005: `sys.path` registration decoupled from logger initialization
22

33
**Date:** 2026-05-17
44
**Status:** Accepted

docs/decisions/0006-local-config-sparse-overlay.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The original framework config mechanism offered a binary choice: use
3030
resolution like `GLOBAL_CONFIG`).
3131

3232
The `src/local/` fork-safe area introduced in ADR-0001 provides a natural home
33-
for customer customisations. Config overrides should follow the same pattern.
33+
for customer customizations. Config overrides should follow the same pattern.
3434

3535
## Decision
3636

@@ -47,7 +47,7 @@ Override detection and deprecation warnings are the **caller's responsibility**.
4747
active, stores the resolved root in `self._active_config_path`, and passes it
4848
to `load_framework_config`. `self._active_config_path` is reused by
4949
`_setup_operational_metadata` so the override detection only runs once per
50-
pipeline initialisation.
50+
pipeline initialization.
5151

5252
- **`load_framework_logger_config`** independently checks
5353
`config/override/logger.json`, emits its own `DeprecationWarning` if active,
@@ -66,7 +66,7 @@ load_framework_config(
6666
) -> Dict
6767
```
6868

69-
Behaviour:
69+
Behavior:
7070

7171
1. When `name` is a **sequence** (e.g. `FrameworkPaths.GLOBAL_CONFIG =
7272
("global.json", "global.yaml", "global.yml")`):

docs/decisions/0008-lakeflow-framework-package.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ module is added.
137137
risk with customer code.
138138
- Existing flat-deploy customers are unaffected: the `src/` shims preserve
139139
backward compatibility, and `framework.sourcePath` + Workspace Files-first
140-
resolution (ADR-0009) means behaviour is identical to pre-v0.20.0.
140+
resolution (ADR-0009) means behavior is identical to pre-v0.20.0.
141141
- Editable installs (`pip install -e ".[contrib]"`) are supported for local
142142
development; the `src/` layout ensures the installed package and the source
143143
tree are the same directory.

docs/decisions/0009-strategy-b-workspace-files-first-resolver.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ first when both a Workspace Files path and the wheel package data are potentiall
3232
- `+` Simple: the wheel is always the canonical source of defaults.
3333
- `` **Breaking for existing flat-deploy customers.** Their defaults live in
3434
Workspace Files; if the wheel shadow-contains a newer (or different) version of a default
35-
file, behaviour silently changes on upgrade.
35+
file, behavior silently changes on upgrade.
3636
- `` Contradicts the "explicit wins" principle: a customer who set
3737
`framework.sourcePath` explicitly expects Workspace Files to be authoritative.
3838

@@ -91,7 +91,7 @@ similar validators.
9191

9292
- **Zero-change upgrade for flat-deploy customers.** Their `framework.sourcePath`
9393
points to the deployed `src/` directory in Workspace Files; those files are
94-
found at step 1 and the wheel is never consulted. Behaviour is identical to
94+
found at step 1 and the wheel is never consulted. Behavior is identical to
9595
pre-v0.20.0.
9696
- **Explicit wins.** Setting `framework.sourcePath` is a deliberate act.
9797
Workspace Files-first honours that intent; package-first would silently override it.
@@ -108,7 +108,7 @@ similar validators.
108108
config and schema reads; call sites that previously used
109109
`os.path.join(framework_path, FrameworkPaths.CONFIG_PATH, name)` are
110110
migrated to it.
111-
- Flat-deploy customers see **no behaviour change** on upgrade to v0.20.0.
111+
- Flat-deploy customers see **no behavior change** on upgrade to v0.20.0.
112112
- Wheel-install customers get defaults from the wheel with no `framework.sourcePath`
113113
required.
114114
- The `src/local/config/` sparse overlay (ADR-0006) continues to work in all

docs/source/architecture/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ The Lakeflow Framework is designed to support different organizational and data
1414
* Federated domain-aligned teams, including data mesh and data product approaches
1515
* Hybrid operating models that combine centralized governance with domain ownership
1616

17-
**Modelling paradigms**
17+
**Modeling paradigms**
1818

1919
* Medallion architecture (Bronze, Silver, Gold)
20-
* Common modelling patterns, including dimensional (facts/dimensions), Data Vault, enterprise canonical/3NF, and other custom enterprise models
20+
* Common modeling patterns, including dimensional (facts/dimensions), Data Vault, enterprise canonical/3NF, and other custom enterprise models
2121

2222
These approaches can be implemented using the same Data Flow Spec-driven patterns, deployment process, and framework features documented in this guide.
2323

docs/source/build/bundle-steps.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,7 @@ See :doc:`/features/data-quality/expectations`.
277277

278278
**Add pipeline logic modules** *(optional)* — if the spec references custom Python
279279
(``pythonModule``, ``pythonTransform.module``, or a custom sink), add modules or packages under ``src/python/``.
280-
The framework adds ``src/python/`` to ``sys.path`` at pipeline initialisation.
280+
The framework adds ``src/python/`` to ``sys.path`` at pipeline initialization.
281281
See :doc:`/features/python/extensions`.
282282

283283
.. note::

docs/source/build/bundle-structure.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ The high-level structure of a Pipeline Bundle never changes and is as follows:
6969
│ ├── init/
7070
│ │ ├── pre/ # Lifecycle scripts — run before SDP declarations (optional)
7171
│ │ └── post/ # Lifecycle scripts — run after SDP declarations (optional)
72-
│ ├── libraries/ # Cluster-install artefacts + sys.path loose .py (optional)
72+
│ ├── libraries/ # Cluster-install artifacts + sys.path loose .py (optional)
7373
│ ├── pipeline_configs/ # Global and env-specific pipeline config (required)
7474
│ └── python/ # Spec-referenced Python modules and packages (optional)
7575
├── databricks.yml
@@ -89,7 +89,7 @@ The ``src/`` directories serve distinct purposes:
8989
- Purpose
9090
* - ``src/dataflows/``
9191
- All Data Flow Spec files. The framework reads every spec file recursively regardless
92-
of sub-folder structure. See below for organisation options.
92+
of sub-folder structure. See below for organization options.
9393
* - ``src/init/pre/`` and ``src/init/post/``
9494
- **Optional.** Lifecycle ``.py`` scripts executed before and after SDP declarations
9595
inside ``initialize_pipeline()``. Run in sorted filename order; files starting
@@ -106,15 +106,15 @@ The ``src/`` directories serve distinct purposes:
106106
* - ``src/python/``
107107
- **Optional.** All customer Python referenced by Data Flow Specs —
108108
``pythonModule``, ``pythonTransform.module``, and custom sinks. Added to
109-
``sys.path`` at pipeline initialisation.
109+
``sys.path`` at pipeline initialization.
110110

111111
.. seealso::
112112

113113
:doc:`/features/python/extensions` — full reference for ``src/libraries/``,
114114
``src/python/``, ``src/init/``, and ``src/local/config/``, including examples,
115115
deprecation notices, and the cluster library installation options.
116116

117-
It is the structure of the ``src/dataflows`` directory that is flexible and can be organised in the way that best suits your standards and ways of working. The Framework will:
117+
It is the structure of the ``src/dataflows`` directory that is flexible and can be organized in the way that best suits your standards and ways of working. The Framework will:
118118

119119
* Read all the Data Flow Spec files under the ``src/dataflows`` directory, regardless of the folder structure. Filtering of the data flows is done when defining your Pipeline and is discussed in the :doc:`/build/bundle-steps` section.
120120
* Expect that the schemas, transforms and expectations related to a Data Flow Spec are located in their respective ``schemas``, ``dml`` and ``expectations`` sub-directories within the Data Flow Spec's home directory.

0 commit comments

Comments
 (0)