diff --git a/docs/doctrine.md b/docs/doctrine.md deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/flysystem.md b/docs/flysystem.md deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/getting-started.md b/docs/getting-started.md deleted file mode 100644 index 593252c8..00000000 --- a/docs/getting-started.md +++ /dev/null @@ -1 +0,0 @@ -//todo diff --git a/docs/README_old.md b/docs/getting-started/project-overview.md similarity index 54% rename from docs/README_old.md rename to docs/getting-started/project-overview.md index 5bad304e..34fe43bd 100644 --- a/docs/README_old.md +++ b/docs/getting-started/project-overview.md @@ -1,26 +1,18 @@ -## Installation +# Getting Started -```bash -composer require yokai/batch -``` - -## Vocabulary +## Project Overview -Because when you start with any library -it is important to understand what are the concepts introduced in it. +For a step-by-step presentation of the batch library, we're going to focus on a simple requirement. +Update products and stocks via an Excel import. -This is highly recommended that you read this entire page -before starting to work with this library. -### Job +### What is a job technically ? A job is the class that is responsible for **what** your code is doing. This is the class you will have to create (or reuse), as it contains the business logic required for what you wish to achieve. -The only requirement is implementing [`JobInterface`](../src/batch/src/Job/JobInterface.php), - -For exemple you can have a job for generate a csv: +The only requirement is implementing [`JobInterface`](../../src/batch/src/Job/JobInterface.php), ```php launch('your.job.name', ['job' => ['configuration']]); ``` -#### See More: -- [Job Launcher](batch/domain/job-launcher.md) - -### JobExecution: +#### More information you need know: +##### JobExecution: -A [JobExecution](../src/batch/src/JobExecution.php) is the class that holds information about one execution of a job. +A [JobExecution](../../src/batch/src/JobExecution.php) is the class that holds information about one execution of a job. #### What kind of information does it hold ? - `JobExecution::$jobName` : The Job name (job id) @@ -119,34 +93,9 @@ A [JobExecution](../src/batch/src/JobExecution.php) is the class that holds info - `JobExecution::$logs` : Some logs - `JobExecution::$childExecutions` : Some child execution -### JobExecutionStorage +#### JobExecutionStorage Whenever a job is launched, whether is starts immediately or not, an execution is stored for it. The execution are stored to allow you to keep an eye on what is happening. This persistence is on the responsibility of the job execution storage. -- [Job Execution Storage](batch/domain/job-execution-storage.md) - - -## Next steps -- [Getting Started (Nom de l'exemple)](getting-started.md) -- Framework: - - [Symfony](symfony.md) -- Bridge: - - Doctrine: - - [Dbal](batch-doctrine-dbal/job-execution-storage.md) - - [ORM](batch-doctrine-orm/entity-item-reader.md) - - [Persistence](batch-doctrine-persistence/object-registry.md) - -[//]: # ( Todo: link object-item-writer.md ?) -- [Flysystem bridge](flysystem.md) -- [Box OpenSpout bridge](openspout.md) - -[//]: # (Todo: La partie symfony est-elle vraiment utile ? Ou peut être que l'on peut la mettre dans une catégorie a pat entiére ?) -- Symfony: - - [Console](batch-symfony-console/command.md) - - [Messenger](batch-symfony-messenger/job-launcher.md) - - [Serializer](batch-symfony-serializer/job-execution-serializer.md) - - [Validator](batch-symfony-validator/skip-invalid-item-processor.md) - -[//]: # (Idée d'exemple pour le getting started:) -[//]: # (- Un import like Cizeta sans symfony) +- [Job Execution Storage](../batch/domain/job-execution-storage.md) diff --git a/docs/openspout.md b/docs/openspout.md deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/symfony.md b/docs/symfony.md deleted file mode 100644 index e69de29b..00000000