IBX-6270 merge down

.github/pull_request_template.md

@@ -2,5 +2,16 @@
 | ------------- | ---
 | JIRA Ticket   | <!-- URLs to GitHub or JIRA issue(s) (or N/A) -->
 | Versions      | <!-- product version number, e.g.: 1.7, 1.13, 2.0 -->
+| Edition       | <!-- Connect, Experience, Commerce -->
 
 <!-- Replace this comment with Pull Request description -->
+
+#### Checklist
+
+- [ ] Text renders correctly
+- [ ] Text has been checked with vale
+- [ ] Description metadata is up to date
+- [ ] Redirects cover removed/moved pages
+- [ ] Code samples are working
+- [ ] PHP code samples have been fixed with PHP CS fixer
+- [ ] Added link to this PR in relevant JIRA ticket or code PR

.github/workflows/build.yaml

@@ -0,0 +1,62 @@
+name: 'Build & test documentation'
+
+on:
+    push:
+        branches:
+            - master
+            - '[0-9]+.[0-9]+'
+    pull_request: ~
+
+jobs:
+    build:
+        permissions:
+          # Give the default GITHUB_TOKEN write permission to commit and push the
+          # added or changed files to the repository.
+          contents: write
+
+        runs-on: ubuntu-latest
+        strategy:
+            matrix:
+                python-version: [3.8]
+
+        steps:
+            -   uses: actions/checkout@v3
+            -   name: Set up Python ${{ matrix.python-version }}
+                uses: actions/setup-python@v3
+                with:
+                    python-version: ${{ matrix.python-version }}
+            -   name: Install php-cs-fixer
+                run: composer require friendsofphp/php-cs-fixer --dev
+            -   name: Run PHP CS Fixer
+                run: ./vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.php -v --show-progress=dots
+            -   name: Commit changes
+                uses: stefanzweifel/git-auto-commit-action@v4
+                with:
+                    commit_message: PHP CS Fixes
+            -   name: Install dependencies
+                run: |
+                    python -m pip install --upgrade pip
+                    if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+            -   name: Run build
+                run: |
+                    mkdocs build --strict
+
+    vale-check:
+        runs-on: ubuntu-latest
+        if: github.event_name == 'pull_request'
+
+        steps:
+            -   uses: actions/checkout@v3
+            -   name: Get Vale.sh configs
+                env:
+                    TOKEN: ${{ secrets.EZROBOT_PAT }}
+                run: |
+                    curl -H "Authorization: token $TOKEN" -L https://github.com/ibexa/vale-styles/archive/refs/heads/main.zip -o vale.zip
+                    unzip vale.zip
+                    rm vale.zip
+                    mv vale-styles-main/* vale-styles-main/.vale.ini .
+            -   name: Run Vale.sh
+                uses: errata-ai/vale-action@reviewdog
+                with:
+                  reporter: github-check
+                  filter_mode: added

.gitignore

@@ -1,2 +1,7 @@
 /vendor/
 **/.DS_Store
+__pycache__/*
+/site/
+**/.idea/
+.php-cs-fixer.cache
+composer.lock

.php-cs-fixer.php

@@ -0,0 +1,27 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+use Ibexa\CodeStyle\PhpCsFixer\InternalConfigFactory;
+
+$configFactory = new InternalConfigFactory();
+$configFactory->withRules([
+    'header_comment' => false,
+]);
+
+return $configFactory
+    ->buildConfig()
+    ->setFinder(
+        PhpCsFixer\Finder::create()
+            ->in(
+                array_filter([
+                    __DIR__ . '/code_samples',
+                    __DIR__ . '/tests',
+                ], 'is_dir')
+            )
+            ->files()->name('*.php')
+    );

.readthedocs.yml

@@ -2,10 +2,14 @@ version: 2
 
 mkdocs:
   configuration: mkdocs.yml
-  fail_on_warning: false
+  fail_on_warning: true
+
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.11"
 
 python:
-  version: 3.6
   install:
     - requirements: pip_require.txt
     - requirements: requirements.txt

README.md

@@ -1,24 +1,55 @@
-# eZ Platform Developer Documentation
+# Ibexa DXP Developer Documentation
 
-This repository is the source for the [developer documentation for eZ Platform](https://doc.ezplatform.com),
-an open source CMS based on the Symfony Full Stack Framework in PHP.
+This repository is the source for the [developer documentation for Ibexa](https://doc.ibexa.co/en/latest),
+a digital experience platform that is based on the Symfony Full Stack Framework in PHP.
 
 # Resources
 
-1. eZ Platform Developer Hub: https://ezplatform.com/
-1. eZ Platform Repository: https://github.com/ezsystems/ezplatform
-1. Open JIRA board: https://jira.ez.no/
-1. Ibexa Website: https://ibexa.co/
-1. User documentation: https://doc.ezplatform.com/projects/userguide/en/latest/
-1. Personalization Solution: https://doc.ezplatform.com/projects/ezpersonalization/en/latest/
+1. Ibexa DXP Developer Hub: https://developers.ibexa.co
+1. Ibexa DXP Repository: https://github.com/ibexa/oss
+1. Open JIRA board: https://issues.ibexa.co
+1. Ibexa Website: https://ibexa.co
+1. User documentation: https://doc.ibexa.co/projects/userguide
 
+## How to contribute
 
-## How to Contribute
-https://doc.ezplatform.com/en/master/community_resources/contributing/#contribute-to-documentation
+To contribute to the documentation, you can open a PR in this repository.
 
-Invite yourself to the community Slack and join `#documentation-contrib`
+If you'd like to see Ibexa DXP in your language, you can [contribute to the translations](https://doc.ibexa.co/en/latest/resources/contributing/contribute_translations/).
 
-https://ez-community-on-slack.herokuapp.com/
+### Contribute to API reference
+
+The REST API Reference is located in the `docs/api/rest_api/rest_api_reference/rest_api_reference.html` 
+file, which is generated automatically by the RAML2HTML tool.
+It is based on `*.raml` files located in the `docs/api/rest_api/rest_api_reference/input` directory that you can edit in your editor/IDE.
+
+After you modify relevant files in the input folder, you can generate an HTML file from repository root (this step can also be performed by one of the Tech Writers during PR review): 
+
+`php tools/raml2html/raml2html.php build --non-standard-http-methods=COPY,MOVE,PUBLISH,SWAP -t default -o docs/api/rest_api/rest_api_reference/output/ docs/api/rest_api/rest_api_reference/input/ez.raml`
+
+In case of errors, look for mistakes in the RAML file, for example, double apostrophes.
+Move `rest_api_reference.html`  from the output folder to `docs/api/rest_api/rest_api_reference/` root.
+
+See `tools/raml2html/README.md` for more information.
+
+## Build and preview documentation
+
+To build and preview your changes locally, you need to install Python along with its package manager (`pip`).
+Other required tools will be installed by using the following command:
+
+```bash
+pip install -r requirements.txt
+```
+
+Then you can run:
+
+```bash
+mkdocs serve
+```
+
+After a short while your documentation should be reachable at http://localhost:8000. If it isn't, check the output
+of the command.
 
 ## Where to View
-https://doc.ezplatform.com
+
+https://doc.ibexa.co

code_samples/api/migration/src/Command/MigrationCommand.php

@@ -0,0 +1,38 @@
+<?php declare(strict_types=1);
+
+namespace App\Command;
+
+use Ibexa\Platform\Migration\Repository\Migration;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+final class MigrationCommand extends Command
+{
+    protected static $defaultName = 'doc:migration';
+
+    private $migrationService;
+
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $string_with_migration_content = '';
+        $this->migrationService->add(
+            new Migration(
+                'new_migration.yaml',
+                $string_with_migration_content
+            )
+        );
+
+        foreach ($this->migrationService->listMigrations() as $migration) {
+            $output->writeln($migration->getName());
+        }
+
+        $migration_name = $this->migrationService->listMigrations()[0]->getName();
+        $my_migration = $this->migrationService->findOneByName($migration_name);
+
+        $this->migrationService->executeOne($my_migration);
+        $this->migrationService->executeAll('admin');
+
+        return self::SUCCESS;
+    }
+}

code_samples/api/public_php_api/config/packages/views.yaml

@@ -0,0 +1,12 @@
+ezplatform:
+    system:
+        site:
+            content_view:
+                full:
+                    folder:
+                        controller: App\Controller\CustomController::showContentAction
+#                        controller: App\Controller\PaginationController::showContentAction
+#                        controller: App\Controller\CustomFilterController::showChildrenAction
+#                        template: custom_filter.html.twig
+                        match:
+                            Identifier\ContentType: [folder]

code_samples/api/public_php_api/src/Command/AddLanguageCommand.php

@@ -0,0 +1,52 @@
+<?php declare(strict_types=1);
+
+namespace App\Command;
+
+use eZ\Publish\API\Repository\LanguageService;
+use eZ\Publish\API\Repository\PermissionResolver;
+use eZ\Publish\API\Repository\UserService;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class AddLanguageCommand extends Command
+{
+    private $languageService;
+
+    private $userService;
+
+    private $permissionResolver;
+
+    public function __construct(LanguageService $languageService, UserService $userService, PermissionResolver $permissionResolver)
+    {
+        $this->languageService = $languageService;
+        $this->userService = $userService;
+        $this->permissionResolver = $permissionResolver;
+        parent::__construct('doc:add_language');
+    }
+
+    protected function configure()
+    {
+        $this->setDescription('Lists available languages and add Polish.');
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $user = $this->userService->loadUserByLogin('admin');
+        $this->permissionResolver->setCurrentUserReference($user);
+
+        $languageList = $this->languageService->loadLanguages();
+
+        foreach ($languageList as $language) {
+            $output->writeln($language->languageCode . ': ' . $language->name);
+        }
+
+        $languageCreateStruct = $this->languageService->newLanguageCreateStruct();
+        $languageCreateStruct->languageCode = 'pol-PL';
+        $languageCreateStruct->name = 'Polish';
+        $this->languageService->createLanguage($languageCreateStruct);
+        $output->writeln('Added language Polish with language code pol-PL.');
+
+        return self::SUCCESS;
+    }
+}

code_samples/api/public_php_api/src/Command/AddLocationToContentCommand.php

@@ -0,0 +1,63 @@
+<?php declare(strict_types=1);
+
+namespace App\Command;
+
+use eZ\Publish\API\Repository\ContentService;
+use eZ\Publish\API\Repository\LocationService;
+use eZ\Publish\API\Repository\PermissionResolver;
+use eZ\Publish\API\Repository\UserService;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class AddLocationToContentCommand extends Command
+{
+    private $contentService;
+
+    private $locationService;
+
+    private $userService;
+
+    private $permissionResolver;
+
+    public function __construct(ContentService $contentService, LocationService $locationService, UserService $userService, PermissionResolver $permissionResolver)
+    {
+        $this->contentService = $contentService;
+        $this->locationService = $locationService;
+        $this->userService = $userService;
+        $this->permissionResolver = $permissionResolver;
+        parent::__construct('doc:add_location');
+    }
+
+    protected function configure()
+    {
+        $this
+            ->setDescription('Add a Location to Content item and hides it.')
+            ->setDefinition([
+                new InputArgument('contentId', InputArgument::REQUIRED, 'Content ID'),
+                new InputArgument('parentLocationId', InputArgument::REQUIRED, 'Parent Location ID'),
+            ]);
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $user = $this->userService->loadUserByLogin('admin');
+        $this->permissionResolver->setCurrentUserReference($user);
+
+        $parentLocationId = $input->getArgument('parentLocationId');
+        $contentId = $input->getArgument('contentId');
+
+        $locationCreateStruct = $this->locationService->newLocationCreateStruct($parentLocationId);
+
+        $locationCreateStruct->priority = 500;
+        $locationCreateStruct->hidden = true;
+
+        $contentInfo = $this->contentService->loadContentInfo($contentId);
+        $newLocation = $this->locationService->createLocation($contentInfo, $locationCreateStruct);
+
+        $output->writeln('Added hidden location ' . $newLocation->id . ' to Content item: ' . $contentInfo->name);
+
+        return self::SUCCESS;
+    }
+}