Skip to content

chore: create standalone installation instructions for each package #2277

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.

Sign up for GitHub

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

Merged
norberttech merged 1 commit into from
Mar 27, 2026
Merged

chore: create standalone installation instructions for each package #2277

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 7 additions & 2 deletions documentation/components/adapters/avro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
# Avro Adapter

- [⬅️️ Back](/documentation/introduction.md)
- [➡️ Installation](/documentation/installation/packages/etl-adapter-avro.md)

Avro integration was temporarily abandoned due to the lack of availability of good libraries for PHP.
Avro integration was temporarily abandoned due to the lack of availability of good libraries for PHP.
If you are interested in this integration, please let us know by creating an issue in the repository.

At some point in the future we are going to write our own Avro library for PHP, but it is not a priority at the moment.
At some point in the future we are going to write our own Avro library for PHP, but it is not a priority at the moment.

## Installation

For detailed installation instructions, see the [installation page](/documentation/installation/packages/etl-adapter-avro.md).
5 changes: 2 additions & 3 deletions documentation/components/adapters/chartjs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

- [⬅️️ Back](/documentation/introduction.md)
- [📦Packagist](https://packagist.org/packages/flow-php/etl-adapter-chartjs)
- [➡️ Installation](/documentation/installation/packages/etl-adapter-chartjs.md)
- [🐙GitHub](https://github.com/flow-php/etl-adapter-chartjs)
- [📚API Reference](/documentation/api/adapter/chartjs)
- [📁Files](/documentation/api/adapter/chartjs/indices/files.html)
Expand All @@ -22,9 +23,7 @@ with the robust and adaptable framework of the Flow PHP ecosystem.

## Installation

```
composer require flow-php/etl-adapter-chartjs:~--FLOW_PHP_VERSION--
```
For detailed installation instructions, see the [installation page](/documentation/installation/packages/etl-adapter-chartjs.md).

## Usage

Expand Down
5 changes: 2 additions & 3 deletions documentation/components/adapters/csv.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

- [⬅️️ Back](/documentation/introduction.md)
- [📦Packagist](https://packagist.org/packages/flow-php/etl-adapter-csv)
- [➡️ Installation](/documentation/installation/packages/etl-adapter-csv.md)
- [🐙GitHub](https://github.com/flow-php/etl-adapter-csv)
- [📚API Reference](/documentation/api/adapter/csv)
- [📁Files](/documentation/api/adapter/csv/indices/files.html)
Expand All @@ -21,9 +22,7 @@ aligning with the robust and adaptable framework of the Flow PHP ecosystem.

## Installation

```
composer require flow-php/etl-adapter-csv:~--FLOW_PHP_VERSION--
```
For detailed installation instructions, see the [installation page](/documentation/installation/packages/etl-adapter-csv.md).

## Extractor

Expand Down
5 changes: 2 additions & 3 deletions documentation/components/adapters/doctrine.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

- [⬅️️ Back](/documentation/introduction.md)
- [📦Packagist](https://packagist.org/packages/flow-php/etl-adapter-doctrine)
- [➡️ Installation](/documentation/installation/packages/etl-adapter-doctrine.md)
- [🐙GitHub](https://github.com/flow-php/etl-adapter-doctrine)
- [📚API Reference](/documentation/api/adapter/doctrine)
- [📁Files](/documentation/api/adapter/doctrin/indices/files.html)
Expand All @@ -22,9 +23,7 @@ robust and adaptable nature of the Flow PHP ecosystem.

## Installation

```
composer require flow-php/etl-adapter-doctrine:~--FLOW_PHP_VERSION--
```
For detailed installation instructions, see the [installation page](/documentation/installation/packages/etl-adapter-doctrine.md).

## Description

Expand Down
5 changes: 2 additions & 3 deletions documentation/components/adapters/elasticsearch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

- [⬅️️ Back](/documentation/introduction.md)
- [📦Packagist](https://packagist.org/packages/flow-php/etl-adapter-elasticsearch)
- [➡️ Installation](/documentation/installation/packages/etl-adapter-elasticsearch.md)
- [🐙GitHub](https://github.com/flow-php/etl-adapter-elasticsearch)
- [📚API Reference](/documentation/api/adapter/elasticsearch)
- [📁Files](/documentation/api/adapter/elasticsearch/indices/files.html)
Expand All @@ -22,9 +23,7 @@ efficient endeavor, harmoniously aligning with the robust and adaptable framewor

## Installation

```
composer require flow-php/etl-adapter-elasticsearch:~--FLOW_PHP_VERSION--
```
For detailed installation instructions, see the [installation page](/documentation/installation/packages/etl-adapter-elasticsearch.md).

## Description

Expand Down
5 changes: 2 additions & 3 deletions documentation/components/adapters/excel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

- [⬅️️ Back](/documentation/introduction.md)
- [📦Packagist](https://packagist.org/packages/flow-php/etl-adapter-excel)
- [➡️ Installation](/documentation/installation/packages/etl-adapter-excel.md)
- [🐙GitHub](https://github.com/flow-php/etl-adapter-excel)
- [📚API Reference](/documentation/api/adapter/excel)
- [📁Files](/documentation/api/adapter/excel/indices/files.html)
Expand All @@ -25,9 +26,7 @@ with the robust and adaptable nature of the Flow PHP ecosystem.

## Installation

```
composer require flow-php/etl-adapter-excel:~--FLOW_PHP_VERSION--
```
For detailed installation instructions, see the [installation page](/documentation/installation/packages/etl-adapter-excel.md).

## Extractor

Expand Down
5 changes: 2 additions & 3 deletions documentation/components/adapters/google-sheet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

- [⬅️️ Back](/documentation/introduction.md)
- [📦Packagist](https://packagist.org/packages/flow-php/etl-adapter-google-sheet)
- [➡️ Installation](/documentation/installation/packages/etl-adapter-google-sheet.md)
- [🐙GitHub](https://github.com/flow-php/etl-adapter-google-sheet)
- [📚API Reference](/documentation/api/adapter/google-sheet)
- [📁Files](/documentation/api/adapter/google-sheet/indices/files.html)
Expand All @@ -22,9 +23,7 @@ with the robust and adaptable nature of the Flow PHP ecosystem.

## Installation

```
composer require flow-php/etl-adapter-google-sheet:~--FLOW_PHP_VERSION--
```
For detailed installation instructions, see the [installation page](/documentation/installation/packages/etl-adapter-google-sheet.md).

## Extractor

Expand Down
5 changes: 2 additions & 3 deletions documentation/components/adapters/http.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

- [⬅️️ Back](/documentation/introduction.md)
- [📦Packagist](https://packagist.org/packages/flow-php/etl-adapter-http)
- [➡️ Installation](/documentation/installation/packages/etl-adapter-http.md)
- [🐙GitHub](https://github.com/flow-php/etl-adapter-http)
- [📚API Reference](/documentation/api/adapter/http)
- [📁Files](/documentation/api/adapter/http/indices/files.html)
Expand All @@ -22,9 +23,7 @@ of the Flow PHP ecosystem.

## Installation

```
composer require flow-php/etl-adapter-http:~--FLOW_PHP_VERSION--
```
For detailed installation instructions, see the [installation page](/documentation/installation/packages/etl-adapter-http.md).

## Extractor - PsrHttpClientDynamicExtractor

Expand Down
5 changes: 2 additions & 3 deletions documentation/components/adapters/json.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

- [⬅️️ Back](/documentation/introduction.md)
- [📦Packagist](https://packagist.org/packages/flow-php/etl-adapter-json)
- [➡️ Installation](/documentation/installation/packages/etl-adapter-json.md)
- [🐙GitHub](https://github.com/flow-php/etl-adapter-json)
- [📚API Reference](/documentation/api/adapter/json)
- [📁Files](/documentation/api/adapter/json/indices/files.html)
Expand All @@ -21,9 +22,7 @@ simplified and efficient task, perfectly aligning with the robust and adaptable

## Installation

```
composer require flow-php/etl-adapter-json:~--FLOW_PHP_VERSION--
```
For detailed installation instructions, see the [installation page](/documentation/installation/packages/etl-adapter-json.md).


> Json library is not explicitly required, you need to make sure it is available in your composer.json file.
Expand Down
5 changes: 2 additions & 3 deletions documentation/components/adapters/logger.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

- [⬅️️ Back](/documentation/introduction.md)
- [📦Packagist](https://packagist.org/packages/flow-php/etl-adapter-logger)
- [➡️ Installation](/documentation/installation/packages/etl-adapter-logger.md)
- [🐙GitHub](https://github.com/flow-php/etl-adapter-logger)
- [📚API Reference](/documentation/api/adapter/logger)
- [📁Files](/documentation/api/adapter/logger/indices/files.html)
Expand All @@ -12,9 +13,7 @@ ETL Adapter that provides PSR Logger support for ETL.

## Installation

```
composer require flow-php/etl-adapter-logger:~--FLOW_PHP_VERSION--
```
For detailed installation instructions, see the [installation page](/documentation/installation/packages/etl-adapter-logger.md).

## Loader - PsrLogger

Expand Down
5 changes: 2 additions & 3 deletions documentation/components/adapters/parquet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

- [⬅️️ Back](/documentation/introduction.md)
- [📦Packagist](https://packagist.org/packages/flow-php/etl-adapter-parquet)
- [➡️ Installation](/documentation/installation/packages/etl-adapter-parquet.md)
- [🐙GitHub](https://github.com/flow-php/etl-adapter-parquet)
- [📚API Reference](/documentation/api/adapter/parquet)
- [📁Files](/documentation/api/adapter/parquet/indices/files.html)
Expand All @@ -20,6 +21,4 @@ the robust and adaptable nature of the Flow PHP ecosystem.

## Installation

```
composer require flow-php/etl-adapter-parquet:~--FLOW_PHP_VERSION--
```
For detailed installation instructions, see the [installation page](/documentation/installation/packages/etl-adapter-parquet.md).
5 changes: 2 additions & 3 deletions documentation/components/adapters/postgresql.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

- [⬅️️ Back](/documentation/introduction.md)
- [📦Packagist](https://packagist.org/packages/flow-php/etl-adapter-postgresql)
- [➡️ Installation](/documentation/installation/packages/etl-adapter-postgresql.md)
- [🐙GitHub](https://github.com/flow-php/etl-adapter-postgresql)
- [📚API Reference](/documentation/api/adapter/postgresql)
- [📁Files](/documentation/api/adapter/postgresql/indices/files.html)
Expand All @@ -17,9 +18,7 @@ efficiency.

## Installation

```
composer require flow-php/etl-adapter-postgresql:~--FLOW_PHP_VERSION--
```
For detailed installation instructions, see the [installation page](/documentation/installation/packages/etl-adapter-postgresql.md).

## Requirements

Expand Down
5 changes: 2 additions & 3 deletions documentation/components/adapters/text.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

- [⬅️️ Back](/documentation/introduction.md)
- [📦Packagist](https://packagist.org/packages/flow-php/etl-adapter-text)
- [➡️ Installation](/documentation/installation/packages/etl-adapter-text.md)
- [🐙GitHub](https://github.com/flow-php/etl-adapter-text)
- [📚API Reference](/documentation/api/adapter/text)
- [📁Files](/documentation/api/adapter/text/indices/files.html)
Expand All @@ -22,9 +23,7 @@ the Flow PHP ecosystem.

## Installation

```
composer require flow-php/etl-adapter-text:~--FLOW_PHP_VERSION--
```
For detailed installation instructions, see the [installation page](/documentation/installation/packages/etl-adapter-text.md).

## Extractor

Expand Down
5 changes: 2 additions & 3 deletions documentation/components/adapters/xml.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

- [⬅️️ Back](/documentation/introduction.md)
- [📦Packagist](https://packagist.org/packages/flow-php/etl-adapter-xml)
- [➡️ Installation](/documentation/installation/packages/etl-adapter-xml.md)
- [🐙GitHub](https://github.com/flow-php/etl-adapter-xml)
- [📚API Reference](/documentation/api/adapter/xml)
- [📁Files](/documentation/api/adapter/xml/indices/files.html)
Expand All @@ -21,9 +22,7 @@ aligning perfectly with the robust and adaptable nature of the Flow PHP ecosyste

## Installation

```
composer require flow-php/etl-adapter-xml:~--FLOW_PHP_VERSION--
```
For detailed installation instructions, see the [installation page](/documentation/installation/packages/etl-adapter-xml.md).

## Extractor - XMLExtractor

Expand Down
9 changes: 5 additions & 4 deletions documentation/components/bridges/filesystem-async-aws-bridge.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,17 @@

- [⬅️️ Back](/documentation/introduction.md)
- [📦Packagist](https://packagist.org/packages/flow-php/filesystem-async-aws-bridge)
- [➡️ Installation](/documentation/installation/packages/filesystem-async-aws-bridge.md)
- [🐙GitHub](https://github.com/flow-php/filesystem-async-aws-bridge)
- [📚API Reference](/documentation/api/bridge/filesystem/async-aws)
- [📁Files](/documentation/api/bridge/filesystem/async-aws/indices/files.html)

The Filesystem Async AWS Bridge is a bridge that allows you to use the S3 as a filesystem in your application
The Filesystem Async AWS Bridge is a bridge that allows you to use the S3 as a filesystem in your application
through [Async AWS SDK](https://github.com/async-aws/s3).

```bash
composer require flow-php/filesystem-async-aws-bridge:~--FLOW_PHP_VERSION--
```
## Installation

For detailed installation instructions, see the [installation page](/documentation/installation/packages/filesystem-async-aws-bridge.md).

```php
use function Flow\Filesystem\Bridge\AsyncAWS\DSL\{aws_s3_client, aws_s3_filesystem};
Expand Down
5 changes: 2 additions & 3 deletions documentation/components/bridges/filesystem-azure-bridge.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

- [⬅️️ Back](/documentation/introduction.md)
- [📦Packagist](https://packagist.org/packages/flow-php/filesystem-azure-bridge)
- [➡️ Installation](/documentation/installation/packages/filesystem-azure-bridge.md)
- [🐙GitHub](https://github.com/flow-php/filesystem-azure-bridge)
- [📚API Reference](/documentation/api/bridge/filesystem/azure)
- [📁Files](/documentation/api/bridge/filesystem/azure/indices/files.html)
Expand All @@ -12,9 +13,7 @@ The Filesystem Azure Bridge is a bridge that allows you to use the Azure Blob St

## Installation

```bash
composer require flow-php/filesystem-azure-bridge:~--FLOW_PHP_VERSION--
```
For detailed installation instructions, see the [installation page](/documentation/installation/packages/filesystem-azure-bridge.md).

## Usage

Expand Down
5 changes: 2 additions & 3 deletions documentation/components/bridges/monolog-http-bridge.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

- [⬅️️ Back](/documentation/introduction.md)
- [📦Packagist](https://packagist.org/packages/flow-php/monolog-http-bridge)
- [➡️ Installation](/documentation/installation/packages/monolog-http-bridge.md)
- [🐙GitHub](https://github.com/flow-php/monolog-http-bridge)
- [📚API Reference](/documentation/api/bridge/monolog/http)
- [📁Files](/documentation/api/bridge/monolog/http/indices/files.html)
Expand All @@ -12,9 +13,7 @@ Monolog HTTP Bridge is a package that iterates through LogRecord context and nor

## Installation

```
composer require flow-php/monolog-http-bridge:~--FLOW_PHP_VERSION--
```
For detailed installation instructions, see the [installation page](/documentation/installation/packages/monolog-http-bridge.md).

## Usage

Expand Down
5 changes: 2 additions & 3 deletions documentation/components/bridges/monolog-telemetry-bridge.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ logging interface while exporting logs through Flow's telemetry system.

- [⬅️️ Back](/documentation/introduction.md)
- [📦Packagist](https://packagist.org/packages/flow-php/monolog-telemetry-bridge)
- [➡️ Installation](/documentation/installation/packages/monolog-telemetry-bridge.md)
- [🐙GitHub](https://github.com/flow-php/monolog-telemetry-bridge)
- [📚API Reference](/documentation/api/bridge/monolog/telemetry)
- [🗺DSL](/documentation/api/bridge/monolog/telemetry/namespaces/flow-bridge-monolog-telemetry-dsl.html)
Expand All @@ -13,9 +14,7 @@ logging interface while exporting logs through Flow's telemetry system.

## Installation

```
composer require flow-php/monolog-telemetry-bridge:~--FLOW_PHP_VERSION--
```
For detailed installation instructions, see the [installation page](/documentation/installation/packages/monolog-telemetry-bridge.md).

## Overview

Expand Down
5 changes: 2 additions & 3 deletions documentation/components/bridges/openapi-specification-bridge.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

- [⬅️️ Back](/documentation/introduction.md)
- [📦Packagist](https://packagist.org/packages/flow-php/openapi-specification-bridge)
- [➡️ Installation](/documentation/installation/packages/openapi-specification-bridge.md)
- [🐙GitHub](https://github.com/flow-php/openapi-specification-bridge)
- [📚API Reference](/documentation/api/bridge/openapi/specification)
- [📁Files](/documentation/api/bridge/openapi/specification/indices/files.html)
Expand All @@ -13,9 +14,7 @@ It enables you to generate OpenAPI documentation from Flow schemas and vice vers

## Installation

```
composer require flow-php/openapi-specification-bridge:~--FLOW_PHP_VERSION--
```
For detailed installation instructions, see the [installation page](/documentation/installation/packages/openapi-specification-bridge.md).

## Usage

Expand Down
5 changes: 2 additions & 3 deletions documentation/components/bridges/phpunit-telemetry-bridge.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,15 @@ PHPUnit extension allowing to collect test suite telemetry and export to OTEL co

- [Back](/documentation/introduction.md)
- [Packagist](https://packagist.org/packages/flow-php/phpunit-telemetry-bridge)
- [➡️ Installation](/documentation/installation/packages/phpunit-telemetry-bridge.md)
- [GitHub](https://github.com/flow-php/phpunit-telemetry-bridge)
- [API Reference](/documentation/api/bridge/phpunit/telemetry)

[TOC]

## Installation

```bash
composer require flow-php/phpunit-telemetry-bridge:~--FLOW_PHP_VERSION--
```
For detailed installation instructions, see the [installation page](/documentation/installation/packages/phpunit-telemetry-bridge.md).

## Configuration

Expand Down
5 changes: 2 additions & 3 deletions documentation/components/bridges/psr18-telemetry-bridge.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,14 @@ Flow PSR-18 Telemetry Bridge provides a traceable HTTP client wrapper for PSR-18

- [⬅️️ Back](/documentation/introduction.md)
- [📦Packagist](https://packagist.org/packages/flow-php/psr18-telemetry-bridge)
- [➡️ Installation](/documentation/installation/packages/psr18-telemetry-bridge.md)
- [🐙GitHub](https://github.com/flow-php/psr18-telemetry-bridge)

[TOC]

## Installation

```
composer require flow-php/psr18-telemetry-bridge:~--FLOW_PHP_VERSION--
```
For detailed installation instructions, see the [installation page](/documentation/installation/packages/psr18-telemetry-bridge.md).

## Overview

Expand Down
Loading
Loading