From 98cbb578860bb1eca2e20171e46dfecccd6530b4 Mon Sep 17 00:00:00 2001 From: Dan Date: Sat, 25 May 2024 00:13:56 +0200 Subject: [PATCH] Move publish views to its own section --- docs/.vitepress/config.mts | 1 + docs/expanding-powergrid/publish-views.md | 32 +++++++++++++++++++++++ docs/get-started/install.md | 10 ------- 3 files changed, 33 insertions(+), 10 deletions(-) create mode 100644 docs/expanding-powergrid/publish-views.md diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 9351a21..310feab 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -118,6 +118,7 @@ export default defineConfig({ text: '🛠️ Expanding PowerGrid', items: [ { text: 'Perfomance Monitoring', link: '/expanding-powergrid/performance-monitoring' }, + { text: 'Publish Views', link: '/expanding-powergrid/publish-views' }, { text: 'Custom Theme', link: '/expanding-powergrid/custom-theme' }, ], collapsed: false diff --git a/docs/expanding-powergrid/publish-views.md b/docs/expanding-powergrid/publish-views.md new file mode 100644 index 0000000..d7e401d --- /dev/null +++ b/docs/expanding-powergrid/publish-views.md @@ -0,0 +1,32 @@ +# Publish Views + +This section covers publishing PowerGrid views. + +Here you will find: + +[[toc]] + +## Introduction + +Just like in any Laravel package, PowerGrid views are publishable and may be customized to fit your needs. + +PowerGrid Blade Views are more complex than standard HTML-CSS template files. These files contain application code and logic that is regularly updated to introduce new features and address bugs. + +In short, publishing views means that PowerGrid original Blade views will be copied from PowerGrid's `vendor` directory into the directory `resources/views/vendor/livewire-powergrid`. + +As a consequence, from this point on, your application will load the copied version, which remains **unchanged/outdated**, instead of the latest version from PowerGrid. + +## Publishing Views + +::: danger ❗ WARNING + +Be aware that publishing Blade views may result in **BREAKING CHANGES** to your application. + +**DO NOT proceed** if you don't have a clear understanding of the potential risks involved. +::: + +To publish views, run the command: + +```bash +php artisan vendor:publish --tag=livewire-powergrid-views +``` diff --git a/docs/get-started/install.md b/docs/get-started/install.md index 0c61867..86b6fee 100644 --- a/docs/get-started/install.md +++ b/docs/get-started/install.md @@ -44,16 +44,6 @@ php artisan vendor:publish --tag=livewire-powergrid-config This subsection covers optional installations steps. -These steps are only necessary if you wish to customize PowerGrid resources. - -### Publish Views - -To publish Views, run the following command: - -```bash -php artisan vendor:publish --tag=livewire-powergrid-views -``` - ### Publish Translations To publish PowerGrid translation (language) files, run the following command: