Skip to content

Commit c54a966

Browse files
committed
fixed linting
1 parent 91d8b18 commit c54a966

6 files changed

Lines changed: 36 additions & 20 deletions

File tree

docs/book/v1/architecture.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,17 @@ Ties together the four building blocks of the Dotkernel Headless Platform — AP
66

77
## Details
88

9-
The [Headless Platform](introduction.md) principle is to decouple the frontend from the backend services, so any number of outside systems can consume the same backend. Dotkernel implements this with four building blocks, each its own Git repository, which you combine based on your needs:
9+
The [Headless Platform](introduction.md) principle is to decouple the frontend from the backend services, so any number of outside systems can consume the same backend.
10+
Dotkernel implements this with four building blocks, each its own Git repository, which you combine based on your needs:
1011

1112
- **[Dotkernel API](api/introduction.md)** exposes your data to 3rd-party frontends or backends.
1213
- **[Dotkernel Admin](admin/introduction.md)** (optional) manages the data through a simple table-based UI, with built-in reports and graphs.
1314
- **[Dotkernel Queue](queue/introduction.md)** (optional) handles asynchronous task processing as its own microservice.
1415
- **[Core submodule](core/introduction.md)** is the shared codebase that any of the above applications can include, so they all manage database entities and services the same way.
1516

16-
You don't need every piece from the start. You can begin with [just Admin](admin/usage.md) or [just API](api/usage.md) and add the others later as requirements grow. Once you're running more than one application, pull the shared logic out into a [Core submodule](core/creation.md) and include it in each one — a typical setup looks like API + Core, Admin + Core, and Queue + Core, each in its own repository, all reading from the same shared entities and services (see [Using the Core Submodule](core/usage.md)).
17+
You don't need every piece from the start.
18+
You can begin with [just Admin](admin/usage.md) or [just API](api/usage.md) and add the others later as requirements grow.
19+
Once you're running more than one application, pull the shared logic out into a [Core submodule](core/creation.md) and include it in each one — a typical setup looks like API + Core, Admin + Core, and Queue + Core, each in its own repository, all reading from the same shared entities and services (see [Using the Core Submodule](core/usage.md)).
1720

1821
Regardless of which pieces you use, every Dotkernel application and package boots the same way: through a [ConfigProvider](config-provider/introduction.md) that declares its dependencies, handlers, and configuration, merged together by the framework at [bootstrap time](config-provider/functionality.md).
1922

docs/book/v1/core/creation.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ The full steps for creating a submodule are described in [Git Tools – Submodul
2121
2222
First create a new Git repository that will contain the Core code.
2323

24-
> If the existing Core folder already has commit history you want to keep, extract it with a history-preserving tool such as `git subtree split` before pushing to the new repository. Simply creating an empty repository and adding it as a submodule does not carry over the folder's original history.
24+
> If the existing Core folder already has commit history you want to keep, extract it with a history-preserving tool such as `git subtree split` before pushing to the new repository.
25+
> Simply creating an empty repository and adding it as a submodule does not carry over the folder's original history.
2526
2627
To create the submodule in an application, you need to have Git create the `.gitmodules` file in the root of the main repository by running the command below.
2728
Use the url from the new repository you just created instead of `<url>`:

docs/book/v1/getting-started.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ Explains the prerequisites and general installation flow for setting up a Dotker
88

99
Before installing any Dotkernel application, make sure you have:
1010

11-
- **PHP** – Dotkernel API and Admin require PHP 8.3, 8.4, or 8.5. Dotkernel Queue requires PHP 8.4 or 8.5.
11+
- **PHP** – Dotkernel API and Admin require PHP 8.3, 8.4, or 8.5.
12+
Dotkernel Queue requires PHP 8.4 or 8.5.
1213
- **Composer** – used to install and manage dependencies for every Dotkernel application.
1314
- **A relational database** – API and Admin use Doctrine ORM, typically against a MariaDB or MySQL database (the `utf8mb4_general_ci` collation is recommended).
1415
- **Git** – required if you plan to share code across applications via a [Core submodule](core/creation.md).
@@ -18,16 +19,19 @@ Before installing any Dotkernel application, make sure you have:
1819
Both applications follow the same general installation pattern:
1920

2021
1. Clone the application's repository into an empty project directory and install its dependencies with Composer.
21-
2. During installation, Composer may prompt you about registering additional ConfigProviders. Choose not to inject them — the application already includes the [ConfigProviders](config-provider/introduction.md) it needs.
22+
2. During installation, Composer may prompt you about registering additional ConfigProviders.
23+
Choose not to inject them — the application already includes the [ConfigProviders](config-provider/introduction.md) it needs.
2224
3. Duplicate the distributed configuration files (for example the local and CORS configuration) into their local, non-versioned counterparts, and fill in your database connection parameters.
2325
4. Run the database migrations, and the fixtures if provided, to seed initial data.
2426
5. Enable development mode while you're building the application.
2527

26-
> Dotkernel Admin ships with a default admin account for first login. Change its credentials before deploying to production.
28+
> Dotkernel Admin ships with a default admin account for first login.
29+
> Change its credentials before deploying to production.
2730
2831
### Installing Dotkernel Queue
2932

30-
Dotkernel Queue is set up separately from API and Admin, since it centers on asynchronous message processing rather than a database-backed admin interface. Refer to the official Dotkernel Queue documentation for its installation and message transport configuration steps.
33+
Dotkernel Queue is set up separately from API and Admin, since it centers on asynchronous message processing rather than a database-backed admin interface.
34+
Refer to the official Dotkernel Queue documentation for its installation and message transport configuration steps.
3135

3236
## FAQ
3337

docs/book/v1/glossary.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,12 @@ Plain-language definitions for the standards, frameworks, and terms used through
77
## Details
88

99
**ConfigProvider**
10-
A PHP class, part of an application's bootstrap process, that returns an array of configuration such as dependency injection mappings, request handlers, and template paths. See [ConfigProvider: Introduction](config-provider/introduction.md).
10+
A PHP class, part of an application's bootstrap process, that returns an array of configuration such as dependency injection mappings, request handlers, and template paths.
11+
See [ConfigProvider: Introduction](config-provider/introduction.md).
1112

1213
**Core submodule**
13-
The shared codebase, included as a Git submodule, that centralizes database entities and services across the Dotkernel applications in your platform. See [Core: Introduction](core/introduction.md).
14+
The shared codebase, included as a Git submodule, that centralizes database entities and services across the Dotkernel applications in your platform.
15+
See [Core: Introduction](core/introduction.md).
1416

1517
**Dependency injection (DI) container**
1618
A framework component (e.g. Laminas ServiceManager, PHP-DI, Pimple) that creates and wires together an application's objects based on configuration, instead of that wiring being hardcoded.
@@ -19,16 +21,19 @@ A framework component (e.g. Laminas ServiceManager, PHP-DI, Pimple) that creates
1921
The object-relational mapper (ORM) Dotkernel API and Admin use to manage database entities against a relational database such as MariaDB or MySQL.
2022

2123
**Git submodule**
22-
A Git feature that lets one repository include another repository at a fixed path, so shared code (like the Core submodule) can be versioned and updated independently of the applications that include it. See [Creating a Core Submodule](core/creation.md).
24+
A Git feature that lets one repository include another repository at a fixed path, so shared code (like the Core submodule) can be versioned and updated independently of the applications that include it.
25+
See [Creating a Core Submodule](core/creation.md).
2326

2427
**Headless Platform**
25-
An architecture that decouples the user interface (frontend) from the backend services, so the backend's responses can be consumed by any number of other systems, such as websites or mobile apps. See [Introduction](introduction.md).
28+
An architecture that decouples the user interface (frontend) from the backend services, so the backend's responses can be consumed by any number of other systems, such as websites or mobile apps.
29+
See [Introduction](introduction.md).
2630

2731
**Mezzio**
2832
The PHP micro-framework, part of the Laminas project, that Dotkernel API, Admin, and Queue are all built on.
2933

3034
**Middleware**
31-
A unit of code that sits in a request/response pipeline, able to handle a request and return a response, or delegate to the next middleware in line. Dotkernel applications use a PSR-Compliant Middleware Stack for this.
35+
A unit of code that sits in a request/response pipeline, able to handle a request and return a response, or delegate to the next middleware in line.
36+
Dotkernel applications use a PSR-Compliant Middleware Stack for this.
3237

3338
**Monolith**
3439
A single, tightly coupled codebase where features aren't separated into independent modules — the usual starting point for a [Modular Refactoring](migration/modular-refactoring.md).
@@ -46,4 +51,5 @@ The PSR specification defining HTTP server request handlers and middleware inter
4651
Moving a software system to a new infrastructure or environment — for example, from on-premises servers to the cloud — as part of a broader [migration](migration/introduction.md).
4752

4853
**Stratigility**
49-
The Laminas library that implements the middleware pipeline Mezzio applications run on, iterating over registered middleware in order until a response is returned. See [How the ConfigProvider works](config-provider/functionality.md).
54+
The Laminas library that implements the middleware pipeline Mezzio applications run on, iterating over registered middleware in order until a response is returned.
55+
See [How the ConfigProvider works](config-provider/functionality.md).

docs/book/v1/migration/choosing-a-strategy.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ A decision guide comparing the Full Rewrite, Modular Refactoring, and Strangler
88

99
Each [migration strategy](introduction.md) documented in this section trades off risk, timeline, and cost differently:
1010

11-
| | [Full Rewrite](full-rewrite.md) | [Modular Refactoring](modular-refactoring.md) | [Strangler Fig](strangler-fig.md) |
12-
|---|---|---|---|
13-
| Risk | High — no partial rollback | Moderate — contained to one module at a time once modularized | Low — each change is small and reversible |
14-
| Timeline | Long, with no value delivered until launch | Long upfront preparation, then incremental | Incremental, with continuous delivery |
15-
| Team size | Can be smaller, but works in isolation from the live system | Can scale across teams once modules are defined | Can be smaller, since work is isolated by feature |
11+
| | [Full Rewrite](full-rewrite.md) | [Modular Refactoring](modular-refactoring.md) | [Strangler Fig](strangler-fig.md) |
12+
|-----------------|------------------------------------------------------------------------------------|------------------------------------------------------------------------------|------------------------------------------------------------------------|
13+
| Risk | High — no partial rollback | Moderate — contained to one module at a time once modularized | Low — each change is small and reversible |
14+
| Timeline | Long, with no value delivered until launch | Long upfront preparation, then incremental | Incremental, with continuous delivery |
15+
| Team size | Can be smaller, but works in isolation from the live system | Can scale across teams once modules are defined | Can be smaller, since work is isolated by feature |
1616
| Best suited for | Small or simple systems, or codebases too tightly coupled to migrate incrementally | Large, tightly coupled monoliths that need to be decomposed before migrating | Complex, business-critical legacy systems that can't tolerate downtime |
1717

1818
As a general rule:

docs/book/v1/queue/usage.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@ Explains how Dotkernel Queue fits alongside Dotkernel API and Dotkernel Admin, a
66

77
## Details
88

9-
Dotkernel Queue can be installed independently or alongside other applications in the Dotkernel suite, based on your business requirements. Like API and Admin, it is a separate codebase designed to complement the others — see the [Architecture Overview](../architecture.md) for how the three fit together.
9+
Dotkernel Queue can be installed independently or alongside other applications in the Dotkernel suite, based on your business requirements.
10+
Like API and Admin, it is a separate codebase designed to complement the others — see the [Architecture Overview](../architecture.md) for how the three fit together.
1011

11-
Add Dotkernel Queue once you have work that shouldn't run inline with a request, such as sending bulk emails, generating reports, or processing uploads. Your API or Admin application dispatches a message, and Queue processes it asynchronously in the background, independent of the request/response cycle.
12+
Add Dotkernel Queue once you have work that shouldn't run inline with a request, such as sending bulk emails, generating reports, or processing uploads.
13+
Your API or Admin application dispatches a message, and Queue processes it asynchronously in the background, independent of the request/response cycle.
1214

1315
Because Queue is its own microservice, it can be deployed and scaled separately from API and Admin, and it can consume messages produced by either one.
1416

0 commit comments

Comments
 (0)