Skip to content

Doc refactoring#97

Open
fashxp wants to merge 14 commits into2026.xfrom
doc-refactoring
Open

Doc refactoring#97
fashxp wants to merge 14 commits into2026.xfrom
doc-refactoring

Conversation

@fashxp
Copy link
Copy Markdown
Member

@fashxp fashxp commented Mar 20, 2026

No description provided.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR refactors and restructures the documentation set, moving Platform Version / release note material into a clearer “Pimcore Platform → Updating Pimcore → Release Notes” hierarchy and adding a new “Getting Started” chapter with installation and first-project tutorials.

Changes:

  • Reorganized Platform Version, updating, and release notes docs into doc/02_Pimcore_Platform/... with new index pages.
  • Added a full “Getting Started” section (installation, system requirements, hosting setup, first project tutorial).
  • Removed older top-level/legacy index pages that duplicated or conflicted with the new structure.

Reviewed changes

Copilot reviewed 45 out of 84 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
doc/03_Release_Notes/README.md Removed legacy release-notes index (replaced by new structure).
doc/03_Getting_Started/README.md Added Getting Started chapter landing page.
doc/03_Getting_Started/img/Pimcore_Elements_upload_button.png Added image asset used by Getting Started content.
doc/03_Getting_Started/03_Create_a_First_Project/README.md Added “Create a First Project” tutorial index.
doc/03_Getting_Started/03_Create_a_First_Project/01_Directory_Structure.md Added project directory structure overview.
doc/03_Getting_Started/03_Create_a_First_Project/02_Assets.md Added assets upload tutorial step.
doc/03_Getting_Started/03_Create_a_First_Project/03_Data_Objects.md Added data-object modeling tutorial step.
doc/03_Getting_Started/03_Create_a_First_Project/04_Documents.md Added documents/controllers/templates tutorial step.
doc/03_Getting_Started/02_Product_Registration.md Added product registration documentation.
doc/03_Getting_Started/01_Installation/README.md Added Docker-based installation guide (skeleton + demo enterprise).
doc/03_Getting_Started/01_Installation/01_System_Requirements.md Added system requirements reference for 2026.x stack.
doc/03_Getting_Started/01_Installation/02_System_Setup_and_Hosting/README.md Added system setup & hosting index page.
doc/03_Getting_Started/01_Installation/02_System_Setup_and_Hosting/01_Apache_Configuration.md Added Apache configuration guide.
doc/03_Getting_Started/01_Installation/02_System_Setup_and_Hosting/02_Nginx_Configuration.md Added Nginx configuration guide.
doc/03_Getting_Started/01_Installation/02_System_Setup_and_Hosting/03_File_Permissions.md Added file permissions guide.
doc/03_Getting_Started/01_Installation/02_System_Setup_and_Hosting/04_File_Storage_Setup.md Added Flysystem-based file storage setup guide.
doc/03_Getting_Started/01_Installation/02_System_Setup_and_Hosting/05_Database_Setup.md Added database setup guide.
doc/03_Getting_Started/01_Installation/02_System_Setup_and_Hosting/06_Primary_Replica_Database.md Added primary/replica (clustered) DB configuration guide.
doc/03_Getting_Started/01_Installation/02_System_Setup_and_Hosting/07_Additional_Tools_Installation.md Added tooling installation guide (ffmpeg, gotenberg, optimizers, etc.).
doc/03_Getting_Started/01_Installation/02_System_Setup_and_Hosting/08_Multi_Application_Setup.md Added multi-application/session-collision guidance.
doc/03_Getting_Started/01_Installation/02_System_Setup_and_Hosting/09_Performance_Guide.md Added performance tuning guide (opcache, redis, cache, etc.).
doc/03_Getting_Started/01_Installation/03_Advanced_Installation_Topics/README.md Added advanced installation topics index (automation, bundles, preconfig).
doc/03_Getting_Started/01_Installation/03_Advanced_Installation_Topics/01_Symfony_Messenger.md Added Symfony Messenger guidance (failed jobs, RabbitMQ notes).
doc/03_Getting_Started/01_Installation/03_Advanced_Installation_Topics/02_Pimcore_Studio_Setup.md Added Pimcore Studio bundles installation/config guide.
doc/03_Getting_Started/01_Installation/03_Advanced_Installation_Topics/03_Platform_Version.md Added platform-version meta-package usage notes.
doc/02_Platform_Version_Releases/README.md Removed legacy platform version releases index (superseded).
doc/02_Pimcore_Platform/README.md Added Pimcore Platform chapter landing page.
doc/02_Pimcore_Platform/01_Pimcore_Architecture.md Added architecture overview (layers, stack, delivery patterns).
doc/02_Pimcore_Platform/02_Pimcore_Modules.md Added module catalog by functional area.
doc/02_Pimcore_Platform/03_Pimcore_Editions.md Added edition comparison and module availability table.
doc/02_Pimcore_Platform/04_Platform_Versions/README.md Added platform versions overview, benefits, support policy, releases table.
doc/02_Pimcore_Platform/04_Platform_Versions/01_2026.1.md Added 2026.1 platform module list (planned scope).
doc/02_Pimcore_Platform/04_Platform_Versions/02_2025.4.md Added 2025.4 platform module list.
doc/02_Pimcore_Platform/04_Platform_Versions/03_2025.3.md Added 2025.3 platform module list.
doc/02_Pimcore_Platform/04_Platform_Versions/04_2025.2.md Added 2025.2 platform module list.
doc/02_Pimcore_Platform/04_Platform_Versions/05_2025.1.md Added 2025.1 platform module list.
doc/02_Pimcore_Platform/04_Platform_Versions/06_2024.4.md Added 2024.4 platform module list.
doc/02_Pimcore_Platform/04_Platform_Versions/07_2024.3.md Added 2024.3 platform module list.
doc/02_Pimcore_Platform/04_Platform_Versions/08_2024.2.md Added 2024.2 platform module list.
doc/02_Pimcore_Platform/04_Platform_Versions/09_2024.1.md Added 2024.1 platform module list.
doc/02_Pimcore_Platform/04_Platform_Versions/10_2023.3.md Added 2023.3 platform module list.
doc/02_Pimcore_Platform/04_Platform_Versions/11_2023.2.md Added 2023.2 platform module list.
doc/02_Pimcore_Platform/04_Platform_Versions/12_2023.1.md Added 2023.1 platform module list.
doc/02_Pimcore_Platform/04_Platform_Versions/13_2022.0.md Added 2022.0 platform module list.
doc/02_Pimcore_Platform/05_Updating_Pimcore/README.md Added updating guide (process, platform-version behavior notes).
doc/02_Pimcore_Platform/05_Updating_Pimcore/01_BC_Promise.md Added backward compatibility promise explanation.
doc/02_Pimcore_Platform/05_Updating_Pimcore/02_Release_Notes/README.md Added release notes index for platform versions.
doc/02_Pimcore_Platform/05_Updating_Pimcore/02_Release_Notes/01_2026.1.md Added placeholder release note for unreleased 2026.1.
doc/02_Pimcore_Platform/05_Updating_Pimcore/02_Release_Notes/02_2025.4.md Minor wording/spelling correction in release notes.
doc/02_Pimcore_Platform/05_Updating_Pimcore/02_Release_Notes/03_2025.3.md Added 2025.3 release notes.
doc/02_Pimcore_Platform/05_Updating_Pimcore/02_Release_Notes/04_2025.2.md Spelling correction (“objectbricks”).
doc/02_Pimcore_Platform/05_Updating_Pimcore/02_Release_Notes/05_2025.1.md Wording correction (Studio vs Backend UI).
doc/02_Pimcore_Platform/05_Updating_Pimcore/02_Release_Notes/06_2024.4.md Added 2024.4 release notes.
doc/02_Pimcore_Platform/05_Updating_Pimcore/02_Release_Notes/07_2024.3.md Added 2024.3 release notes.
doc/02_Pimcore_Platform/05_Updating_Pimcore/02_Release_Notes/08_2024.2.md Added 2024.2 release notes.
doc/02_Pimcore_Platform/05_Updating_Pimcore/02_Release_Notes/09_2024.1.md Fixed incorrect version string in existing content.
doc/02_Pimcore_Platform/05_Updating_Pimcore/02_Release_Notes/10_2023.3.md Added 2023.3 release notes.
doc/02_Pimcore_Platform/05_Updating_Pimcore/02_Release_Notes/11_2023.2.md Added 2023.2 release notes.
doc/02_Pimcore_Platform/05_Updating_Pimcore/02_Release_Notes/12_2023.1.md Added 2023.1 release notes.
doc/02_Pimcore_Platform/05_Updating_Pimcore/03_Major_Version_Upgrades.md Added major version upgrade guide.
doc/01_Setup.md Removed legacy setup doc (content moved into new structure).
doc/01_Pimcore_Overview/README.md Added Pimcore overview chapter landing page.
doc/01_Pimcore_Overview/02_Pimcore_UI.md Added Pimcore Studio UI overview.
doc/01_Pimcore_Overview/03_Pimcore_Data_Elements.md Added documents/assets/data objects overview.
doc/01_Pimcore_Overview/04_Pimcore_Community.md Added community/contributing overview.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants