Reorganized documentation

[norberttech]

Change Log

Added

Fixed

Changed

• All documentation pages are now moved to monorepo

Removed

Deprecated

Security

---

Description

New structure:

docs
├── assets
│   └── img
│       ├── daisy_bush.png
│       ├── flow_php_banner_02_2022.png
│       ├── light_slate_blue.png
│       ├── mirage.png
│       ├── sunset_orange.png
│       └── warm_blue.png
├── components
│   ├── adapters
│   │   ├── avro.md
│   │   ├── chartjs.md
│   │   ├── csv.md
│   │   ├── doctrine.md
│   │   ├── elasticsearch.md
│   │   ├── filesystem.md
│   │   ├── google-sheet.md
│   │   ├── http.md
│   │   ├── json.md
│   │   ├── logger.md
│   │   ├── meilisearch.md
│   │   ├── parquet.md
│   │   ├── text.md
│   │   └── xml.md
│   ├── core
│   │   ├── aggregations.md
│   │   ├── building-blocks.md
│   │   ├── caching.md
│   │   ├── core.md
│   │   ├── display.md
│   │   ├── error-handling.md
│   │   ├── filter.md
│   │   ├── group-by.md
│   │   ├── join.md
│   │   ├── limit.md
│   │   ├── map.md
│   │   ├── rename.md
│   │   ├── schema.md
│   │   ├── select-drop.md
│   │   ├── sort.md
│   │   ├── until.md
│   │   └── window-functions.md
│   └── libs
│       ├── array-dot.md
│       ├── doctrine-dbal-bulk.md
│       ├── dremel.md
│       ├── parquet-viewer.md
│       ├── parquet.md
│       └── snappy.md
├── installation
│   └── docker.md
├── installation.md
├── introduction.md
├── quick-start.md
└── style-guide.md

8 directories, 48 files

[github-actions]

Flow PHP - Benchmarks

^{_{Results of the benchmarks from this PR are compared with the results from 1.x branch.}}

Extractors

+-----------------------+-------------------+------+-----+------------------+------------------+-----------------+
| benchmark             | subject           | revs | its | mem_peak         | mode             | rstdev          |
+-----------------------+-------------------+------+-----+------------------+------------------+-----------------+
| AvroExtractorBench    | bench_extract_10k | 1    | 3   | 35.132mb -0.03%  | 690.165ms +1.09% | ±2.16% +174.89% |
| CSVExtractorBench     | bench_extract_10k | 1    | 3   | 4.803mb +0.35%   | 303.350ms +0.51% | ±0.26% +125.57% |
| JsonExtractorBench    | bench_extract_10k | 1    | 3   | 4.902mb +0.34%   | 928.233ms +0.61% | ±0.39% -71.02%  |
| ParquetExtractorBench | bench_extract_10k | 1    | 3   | 239.608mb +0.01% | 1.129s +1.46%    | ±1.28% +305.20% |
| TextExtractorBench    | bench_extract_10k | 1    | 3   | 4.681mb +0.36%   | 25.587ms +1.97%  | ±0.80% -14.36%  |
| XmlExtractorBench     | bench_extract_10k | 1    | 3   | 4.682mb +0.36%   | 405.658ms +0.31% | ±0.33% -30.77%  |
+-----------------------+-------------------+------+-----+------------------+------------------+-----------------+

Transformers

+-----------------------------+--------------------------+------+-----+------------------+-----------------+----------------+
| benchmark                   | subject                  | revs | its | mem_peak         | mode            | rstdev         |
+-----------------------------+--------------------------+------+-----+------------------+-----------------+----------------+
| RenameEntryTransformerBench | bench_transform_10k_rows | 1    | 3   | 110.368mb +0.02% | 65.801ms +3.70% | ±1.34% -14.64% |
+-----------------------------+--------------------------+------+-----+------------------+-----------------+----------------+

Loaders

+--------------------+----------------+------+-----+------------------+------------------+------------------+
| benchmark          | subject        | revs | its | mem_peak         | mode             | rstdev           |
+--------------------+----------------+------+-----+------------------+------------------+------------------+
| AvroLoaderBench    | bench_load_10k | 1    | 3   | 94.766mb +0.02%  | 439.247ms -1.52% | ±2.13% +564.38%  |
| CSVLoaderBench     | bench_load_10k | 1    | 3   | 54.843mb +0.03%  | 72.904ms +1.47%  | ±2.33% +2599.26% |
| JsonLoaderBench    | bench_load_10k | 1    | 3   | 105.361mb +0.08% | 58.060ms +1.18%  | ±0.58% -51.46%   |
| ParquetLoaderBench | bench_load_10k | 1    | 3   | 320.571mb +0.03% | 1.523s +3.68%    | ±1.84% +27.55%   |
| TextLoaderBench    | bench_load_10k | 1    | 3   | 17.720mb +0.10%  | 41.791ms -1.02%  | ±1.77% +97.63%   |
+--------------------+----------------+------+-----+------------------+------------------+------------------+

Building Blocks

+-------------------------+----------------------------+------+-----+------------------+------------------+-----------------+
| benchmark               | subject                    | revs | its | mem_peak         | mode             | rstdev          |
+-------------------------+----------------------------+------+-----+------------------+------------------+-----------------+
| RowsBench               | bench_chunk_10_on_10k      | 2    | 3   | 76.418mb +0.02%  | 2.916ms +9.95%   | ±3.37% +193.60% |
| RowsBench               | bench_diff_left_1k_on_10k  | 2    | 3   | 96.211mb +0.02%  | 182.252ms -0.51% | ±0.53% +302.87% |
| RowsBench               | bench_diff_right_1k_on_10k | 2    | 3   | 74.737mb +0.02%  | 18.556ms +2.46%  | ±0.97% +913.42% |
| RowsBench               | bench_drop_1k_on_10k       | 2    | 3   | 77.658mb +0.02%  | 1.955ms +16.94%  | ±2.10% +35.24%  |
| RowsBench               | bench_drop_right_1k_on_10k | 2    | 3   | 77.658mb +0.02%  | 1.917ms +13.63%  | ±3.14% +257.11% |
| RowsBench               | bench_entries_on_10k       | 2    | 3   | 74.770mb +0.02%  | 2.736ms +7.18%   | ±1.03% -57.97%  |
| RowsBench               | bench_filter_on_10k        | 2    | 3   | 75.299mb +0.02%  | 14.841ms -10.32% | ±3.20% +162.19% |
| RowsBench               | bench_find_on_10k          | 2    | 3   | 75.299mb +0.02%  | 14.778ms -10.24% | ±1.27% -4.93%   |
| RowsBench               | bench_find_one_on_10k      | 10   | 3   | 73.202mb +0.02%  | 1.806μs -4.64%   | ±2.57% +1.82%   |
| RowsBench               | bench_first_on_10k         | 10   | 3   | 73.202mb +0.02%  | 0.400μs +33.33%  | ±0.00% +0.00%   |
| RowsBench               | bench_flat_map_on_1k       | 2    | 3   | 86.759mb +0.02%  | 13.038ms +3.68%  | ±3.77% +312.47% |
| RowsBench               | bench_map_on_10k           | 2    | 3   | 116.118mb +0.01% | 64.268ms +0.18%  | ±0.85% +59.72%  |
| RowsBench               | bench_merge_1k_on_10k      | 2    | 3   | 75.820mb +0.02%  | 1.787ms -2.57%   | ±2.21% +30.69%  |
| RowsBench               | bench_partition_by_on_10k  | 2    | 3   | 78.093mb +0.02%  | 33.810ms +0.45%  | ±1.55% +124.73% |
| RowsBench               | bench_remove_on_10k        | 2    | 3   | 77.920mb +0.02%  | 3.874ms +0.38%   | ±0.51% -44.70%  |
| RowsBench               | bench_sort_asc_on_1k       | 2    | 3   | 73.347mb +0.02%  | 39.598ms +0.66%  | ±0.30% -87.52%  |
| RowsBench               | bench_sort_by_on_1k        | 2    | 3   | 73.348mb +0.02%  | 39.525ms +0.81%  | ±0.67% -75.14%  |
| RowsBench               | bench_sort_desc_on_1k      | 2    | 3   | 73.347mb +0.02%  | 40.685ms +2.46%  | ±2.42% +270.03% |
| RowsBench               | bench_sort_entries_on_1k   | 2    | 3   | 75.644mb +0.02%  | 7.383ms +1.37%   | ±0.89% -34.56%  |
| RowsBench               | bench_sort_on_1k           | 2    | 3   | 73.202mb +0.02%  | 28.915ms -0.80%  | ±0.64% -54.60%  |
| RowsBench               | bench_take_1k_on_10k       | 10   | 3   | 73.202mb +0.02%  | 13.359μs +0.39%  | ±1.85% +423.91% |
| RowsBench               | bench_take_right_1k_on_10k | 10   | 3   | 73.202mb +0.02%  | 15.712μs -6.39%  | ±0.60% -81.81%  |
| RowsBench               | bench_unique_on_1k         | 2    | 3   | 96.212mb +0.02%  | 182.160ms -1.85% | ±0.60% +33.70%  |
| TypeDetectorBench       | bench_type_detector        | 1    | 3   | 59.363mb +0.03%  | 333.202ms -0.26% | ±1.28% +68.89%  |
| TypeDetectorBench       | bench_type_detector        | 1    | 3   | 14.286mb +0.12%  | 66.158ms +1.60%  | ±1.43% +106.92% |
| NativeEntryFactoryBench | bench_entry_factory        | 1    | 3   | 115.961mb +0.01% | 388.470ms +3.02% | ±1.78% +182.10% |
| NativeEntryFactoryBench | bench_entry_factory        | 1    | 3   | 59.679mb +0.03%  | 190.399ms +0.93% | ±2.84% +40.36%  |
| NativeEntryFactoryBench | bench_entry_factory        | 1    | 3   | 14.804mb +0.11%  | 40.251ms +0.48%  | ±0.93% -34.67%  |
+-------------------------+----------------------------+------+-----+------------------+------------------+-----------------+