[PoC] IBX-7097: Training structure

docs/trainings/a_training_topic/a_late_training/000_syllabus.md

@@ -0,0 +1,62 @@
+---
+description: Training page template
+---
+
+[[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]]
+# The late training title
+
+## Syllabus
+
+In this training, you learn to… …with HTTP cache…
+
+| Section     | Estimated | Description                                              |
+|:------------|----------:|:---------------------------------------------------------|
+| Lorem ipsum | T minutes | Lorem ipsum dolor sit amet, consectetur adipiscing elit. |
+
+## Requirements
+
+This is what you need to know to set up your training environment.
+
+### Previous trainings
+
+You should have mastered the following training(s) before starting this *The late training title*:
+
+- [An early training](../an_early_training/000_syllabus.md)
+
+### Ibexa DXP edition
+
+[[= product_name_exp =]] is the minimal edition required by this training.
+
+- [[= product_name_exp =]] [[= latest_tag_4_6 =]]
+- [[= product_name_com =]] [[= latest_tag_4_6 =]]
+
+!!! note
+
+    You can use [`experience-skeleton`'s DDEV feature](ddev_interactive_launcher.md#experience)
+
+    For more suggestions about your training environment, see [Training environment](trainings.md#training-environment).
+
+### Cluster elements
+
+This training needs a reverse proxy for HTTP cache. For a local installation, Varnish is recommended.
+
+|       Service | Required | Value        |
+|--------------:|:--------:|:-------------|
+| Search engine |    No    | (Legacy)     |
+|    Cache pool |    No    | (Filesystem) |
+|    HTTP cache | **Yes**  | Varnish      |
+
+### Starting state
+
+To follow this training, you must install code, config and data on top of a fresh installation.
+
+1. Download the [starting state archive](download/a_late_training.start.zip).
+1. Put this archive at the root of your [[= product_name =]] training installation.
+1. In a terminal, run the following commands at the root of your [[= product_name =]] training installation:
+   ```bash
+   unzip a_late_training.start.zip
+   tail -n+2 config/append_to_services.yaml >> config/services.yaml
+   rm config/append_to_services.yaml
+   php bin/console ibexa:migrations:migrate --file=a_late_training_content_types.yml --siteaccess=admin
+   php bin/console ibexa:migrations:migrate --file=a_late_training_contents.yml --siteaccess=admin
+   ```

docs/trainings/a_training_topic/a_late_training/download/start/config/append_to_services.yaml

@@ -0,0 +1,3 @@
+services:
+
+    App\Command\TrainingCommand: ~

docs/trainings/a_training_topic/a_late_training/download/start/src/Command/TrainingCommand.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace App\Command;
+
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class TrainingCommand extends Command
+{
+    protected static $defaultName = 'app:training';
+
+    protected static $defaultDescription = 'Lorem ipsum dolor sit amet';
+
+    public function __construct()
+    {
+        parent::__construct();
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        return Command::SUCCESS;
+    }
+}

docs/trainings/a_training_topic/a_late_training/download/start/src/Migrations/Ibexa/migrations/a_late_training_content_types.yml

@@ -0,0 +1,15 @@
+-
+    type: content_type
+    mode: create
+    metadata:
+        identifier: training_content_type_container
+-
+    type: content_type
+    mode: create
+    metadata:
+        identifier: training_content_type_item
+-
+    type: content_type
+    mode: create
+    metadata:
+        identifier: training_content_type_resource

docs/trainings/a_training_topic/a_late_training/download/start/src/Migrations/Ibexa/migrations/a_late_training_contents.yml

@@ -0,0 +1,17 @@
+-
+    type: content
+    mode: create
+    metadata:
+        contentType: folder
+    location:
+        parentLocationId: 2
+    fields:
+        -
+            fieldDefIdentifier: name
+            languageCode: eng-GB
+            value: Training
+-
+    type: content
+    mode: create
+    metadata:
+        contentType: training_content_type_container

docs/trainings/a_training_topic/a_late_training/download/step_01/templates/themes/standard/full/a_content_type.html.twig

@@ -0,0 +1,4 @@
+{% extends '@ibexadesign/pagelayout.html.twig' %}
+
+{% block content %}
+{% endblock %}

docs/trainings/a_training_topic/a_late_training/download/step_01/templates/themes/training_theme/full/a_content_type.html.twig

@@ -0,0 +1,4 @@
+{% extends '@ibexadesign/pagelayout.html.twig' %}
+
+{% block content %}
+{% endblock %}

docs/trainings/a_training_topic/a_late_training/download/step_01/templates/themes/training_theme/pagelayout.html.twig

@@ -0,0 +1,8 @@
+<!doctype html>
+<html>
+<head>
+</head>
+<body>
+{% block content %}{% endblock %}
+</body>
+</html>

docs/trainings/a_training_topic/an_early_training/000_syllabus.md

@@ -0,0 +1,55 @@
+---
+description: Training page template
+---
+
+# The early training title
+
+## Syllabus
+
+In this training, you learn to…
+
+| Section                                                 |  Estimated | Description                                                                          |
+|:--------------------------------------------------------|-----------:|:-------------------------------------------------------------------------------------|
+| [First chapter](010_first_chapter.md)                   |  2 minutes | Introduction to …                                                                    |
+| First chapter: [Fist section](011_first_section.md)     | 10 minutes | Lorem ipsum dolor sit amet, consectetur adipiscing elit.                             |
+| First chapter: [Second section](012_second_section.md)  | 20 minutes | Sed non risus.                                                                       |
+| [Second chapter](020_second_chapter.md)                 |  3 minutes | Introduction to …                                                                    |
+| Second chapter: [Fist section](021_first_section.md)    | 10 minutes | Suspendisse lectus tortor, dignissim sit amet, adipiscing nec, ultricies sed, dolor. |
+| Second chapter: [Second section](022_second_section.md) | 45 minutes | Cras elementum ultrices diam.                                                        |
+
+## Requirements
+
+This is what you need to know to set up your training environment.
+
+### Previous trainings
+
+You can start this training right away.
+
+### Ibexa DXP edition
+
+This training can be done on all editions.
+
+- [[= product_name_oss =]] [[= latest_tag_4_6 =]]
+- [[= product_name_headless =]] [[= latest_tag_4_6 =]]
+- [[= product_name_exp =]] [[= latest_tag_4_6 =]]
+- [[= product_name_com =]] [[= latest_tag_4_6 =]]
+
+!!! note
+
+    You can use [`oss-skeleton`'s DDEV feature](ddev_interactive_launcher.md#oss)
+
+    For more suggestions about your training environment, see [Training environment](trainings.md#training-environment).
+
+### Cluster elements
+
+This training can be done with the minimal installation.
+
+|       Service | Required | Value        |
+|--------------:|:--------:|:-------------|
+| Search engine |    No    | (Legacy)     |
+|    Cache pool |    No    | (Filesystem) |
+|    HTTP cache |    No    |              |
+
+### Starting state
+
+The training can be done on a fresh clean installation.

docs/trainings/a_training_topic/an_early_training/010_first_chapter.md

@@ -0,0 +1,5 @@
+---
+description: Training page template
+---
+
+# The early training title: First chapter

docs/trainings/a_training_topic/an_early_training/011_first_section.md

@@ -0,0 +1,5 @@
+---
+description: Training page template
+---
+
+# The early training title: First chapter: First section

docs/trainings/a_training_topic/an_early_training/012_second_section.md

@@ -0,0 +1,5 @@
+---
+description: Training page template
+---
+
+# The early training title: First chapter: Second section

docs/trainings/a_training_topic/an_early_training/020_second_chapter.md

@@ -0,0 +1,5 @@
+---
+description: Training page template
+---
+
+# The early training title: Second chapter

docs/trainings/a_training_topic/an_early_training/021_first_section.md

@@ -0,0 +1,5 @@
+---
+description: Training page template
+---
+
+# The early training title: Second chapter: First section

docs/trainings/a_training_topic/an_early_training/022_second_section.md

@@ -0,0 +1,5 @@
+---
+description: Training page template
+---
+
+# The early training title: Second chapter: Second section

docs/trainings/a_training_topic/an_early_training/999_conclusion.md

@@ -0,0 +1,11 @@
+---
+description: Training page template
+---
+
+# The late training title
+
+## Next training(s)
+
+To go further, you can now take the following trainings:
+
+- [A late training](../a_late_training/000_syllabus.md)

docs/trainings/ddev_interactive_launcher.md

@@ -0,0 +1,7 @@
+---
+description: Easily build a DDEV stack, and run Ibexa DXP
+---
+
+# DDEV Interactive launcher
+
+https://github.com/ibexa/website-skeleton/pull/14 documentation

docs/trainings/trainings.md

@@ -0,0 +1,27 @@
+---
+description: Train yourself on different topics
+---
+
+# Trainings
+
+TODO: Introduction to trainings
+
+## Learning path
+
+Each training starts with a list of the trainings you should previously master before going into the selected one.
+
+If you're new to Ibexa DXP, your first training is _[The early training title](docs/trainings/a_training_topic/an_early_training/000_syllabus.md)_.
+
+## Training environment
+
+You need a running instance of Ibexa DXP to take a training.
+
+Each training starts with its technical requirements.
+Some trainings provide some additional set-up (such as code, content, or config) to install before starting the training.
+
+You can use whatever solution that suits you to run an Ibexa DXP in the required edition for your training.
+You'll need to access the Ibexa DXP code, the servers' configs, and command lines.
+
+[DDEV](install_with_ddev.md) can be used to build such training installation.
+
+TODO: Especially with incoming https://github.com/ibexa/website-skeleton/pull/14

mkdocs.yml

@@ -47,6 +47,20 @@ nav:
             - 6. Implement settings: tutorials/generic_field_type/6_settings.md
             - 7. Add basic validation: tutorials/generic_field_type/7_add_a_validation.md
             - 8. Data migration: tutorials/generic_field_type/8_data_migration.md
+    - Trainings:
+        - Trainings: trainings/trainings.md
+        - A training topic:
+            - An early training:
+                - Syllabus: trainings/a_training_topic/an_early_training/000_syllabus.md
+                - 'First chapter: Introduction': trainings/a_training_topic/an_early_training/010_first_chapter.md
+                - 'First chapter: First section': trainings/a_training_topic/an_early_training/011_first_section.md
+                - 'First chapter: Second section': trainings/a_training_topic/an_early_training/012_second_section.md
+                - 'Second chapter: Introduction': trainings/a_training_topic/an_early_training/020_second_chapter.md
+                - 'Second chapter: First section': trainings/a_training_topic/an_early_training/021_first_section.md
+                - 'Second chapter: Second section': trainings/a_training_topic/an_early_training/022_second_section.md
+                - Conclusion: trainings/a_training_topic/an_early_training/999_conclusion.md
+            - A late training:
+                - Syllabus: trainings/a_training_topic/a_late_training/000_syllabus.md
     - API:
         - API: api/api.md
         - PHP API: api/php_api/php_api.md

tools/trainings.downloads.sh

@@ -0,0 +1,10 @@
+for container in $(find docs/trainings -type d -a -name download); do
+  for folder in $(find $container -type d -a -mindepth 1 -a -maxdepth 1); do
+    cd $folder; #pwd;
+    archive="$(basename $(dirname $container)).$(basename $folder).zip";
+    rm -f ../$archive;
+    echo "$archive ← $folder";
+    zip -r ../$archive ./* ;
+    cd - > /dev/null;
+  done;
+done;