From f30f6345761e36fd61b46c64b03d26aaa8fd49c4 Mon Sep 17 00:00:00 2001 From: Hendrik Bugdoll Date: Thu, 28 Aug 2025 13:40:37 +0200 Subject: [PATCH] Fixed more typos, wording & updated links --- docs/guide/admin/jwtspa.md | 12 ++++++------ docs/guide/admin/permission.md | 16 ++++++++-------- docs/guide/app/console.md | 4 ++-- docs/guide/app/filters.md | 2 +- docs/guide/app/language.md | 4 ++-- docs/guide/app/mail.md | 2 +- docs/guide/app/openapi.md | 2 +- docs/guide/app/queue.md | 4 ++-- docs/guide/app/security.md | 4 ++-- docs/guide/app/speed.md | 4 ++-- docs/guide/cms/blocks.md | 2 +- docs/guide/cms/blocktypes.md | 4 ++-- docs/guide/cms/cmslayouts.md | 10 +++++----- docs/guide/cms/menu.md | 2 +- docs/guide/concepts/depandsync.md | 2 +- docs/guide/concepts/elements.md | 2 +- docs/guide/concepts/headless.md | 8 ++++---- docs/guide/dev/arguments.md | 2 +- docs/guide/dev/package.md | 2 +- docs/guide/frontend/intro.md | 6 +++--- docs/guide/frontend/urlrules.md | 4 ++-- docs/guide/installation/index.md | 6 +++--- docs/guide/installation/problems.md | 2 +- docs/guide/installation/structure.md | 4 ++-- docs/guide/lessons/blockform.md | 2 +- docs/guide/lessons/custom-angular-view.md | 2 +- docs/guide/lessons/imagesliderblock.md | 2 +- docs/guide/lessons/module.md | 6 +++--- docs/guide/ngrest/activebutton.md | 4 ++-- docs/guide/ngrest/activeselection.md | 2 +- docs/guide/ngrest/activewindow.md | 4 ++-- docs/guide/ngrest/api.md | 14 +++++++------- docs/guide/ngrest/index.md | 10 +++++----- docs/guide/ngrest/model.md | 2 +- docs/guide/ngrest/plugin-checkboxrelation.md | 2 +- docs/guide/ngrest/plugins.md | 4 ++-- 36 files changed, 82 insertions(+), 82 deletions(-) diff --git a/docs/guide/admin/jwtspa.md b/docs/guide/admin/jwtspa.md index 7aafcf6..8e1b7c3 100644 --- a/docs/guide/admin/jwtspa.md +++ b/docs/guide/admin/jwtspa.md @@ -2,7 +2,7 @@ > available since LUYA admin module version 2.2 -The LUYA admin provides a basic JWT generator including an out of the box authentication system which can proxy requests trough LUYA admin API User and those permission system. +The LUYA admin provides a basic JWT generator including an out-of-the-box authentication system which can proxy requests through LUYA admin API User and those permission system. ## Prerequisite @@ -12,7 +12,7 @@ The LUYA admin provides a basic JWT generator including an out of the box authen ## How it works -As all LUYA admin APIs requerd an authentication are proxied trough LUYA API Users. The life cycle of the JWT request is described as followed (assuming JWT configuration in the module is done accordingly): +As all LUYA admin APIs requerd an authentication are proxied through LUYA API Users. The life cycle of the JWT request is described as followed (assuming JWT configuration in the module is done accordingly): Get the token: @@ -71,7 +71,7 @@ class User extends \luya\admin\ngrest\base\NgRestModel implements luya\admin\bas return 'api-user'; } - // ....... other ngrest models specific content ........... // + // ....... other NgRest models specific content ........... // /* JwtIdentityInterface */ @@ -88,7 +88,7 @@ class User extends \luya\admin\ngrest\base\NgRestModel implements luya\admin\bas } ``` -An NgRest API with additional login, signup and me actions. +A NgRest API with additional login, signup and me actions. ```php /** @@ -167,7 +167,7 @@ If a successfull JWT authentication is made the controllers provide an out of the box solution which works for common CRUD operations (add, view, list, edit, delete). This can be enabled by setting to true. For further CORS config options use . +When working with cross domain requests, each XHR request to the API will make an *option request* or also known as *preflight request*. The controllers provide an out-of-the-box solution which works for common CRUD operations (add, view, list, edit, delete). This can be enabled by setting to true. For further CORS config options use . When working with custom actions you might need to configure the option request for the given method. Therefore you need to configure the API with the following setup: create an URL rule for options request, define the option and make sure the option is available without authentication (its common that option request won't have authentication headers). @@ -219,7 +219,7 @@ A few principals regarding permissions: + Unless an action is masked as **every action requires authentication**. + If the group of the defined API user has **no permissions**, only your custom actions are accessible. + When accessing NgRest API actions like update, create, list or view (detail) and permission is granted the actions are logged with the configured API User. -+ As permission is proxied trough API Users, a valid API User token could access those informations as well. ++ As permission is proxied through API Users, a valid API User token could access those informations as well. ## User Based CheckAccess diff --git a/docs/guide/admin/permission.md b/docs/guide/admin/permission.md index 8021f7a..cbb83fb 100644 --- a/docs/guide/admin/permission.md +++ b/docs/guide/admin/permission.md @@ -1,15 +1,15 @@ # Permissions & Menu -LUYA provides an out of the box permission system. Menu entries are bound to the permission system but you can also define custom permissions. In order to update permissions run the `./vendor/bin/luya import` command which will restore all permissions in the database that you can allocate them to a user group. +LUYA provides an out-of-the-box permission system. Menu entries are bound to the permission system but you can also define custom permissions. In order to update permissions run the `./vendor/bin/luya import` command which will restore all permissions in the database that you can allocate them to a user group. Permissions are commonly part of the method but can also be defined in or . In order to make wording clear in this guide section: + Authentication: This means you have to provide an access token, bearer auth header or session based authentication mechanism in order to access the given resource. -+ Permission: This means an API or WEB-Route is stored in the LUYA ADMIN permission system and can be associated to given groups which can be then associated to users (both users and API users). For example, users can be edited, added and deleted. ++ Permission: This means an API or WEB route is stored in the LUYA ADMIN permission system and can be associated to given groups which can be then associated to users (both users and API users). For example, users can be edited, added and deleted. + User vs API User: API Users are not able to login in the admin UI, while Users do. There are also other limitations, like API Users can not access actions without permission entries, if disabled (which is by default) -+ REST/API vs WEB: A REST/API Controller will return JSON or XML formatted content and authentication must be done via token, while a web controller returns HTML (scalar values) and authentication is done trough session cookie. ++ REST/API vs WEB: A REST/API Controller will return JSON or XML formatted content and authentication must be done via token, while a web controller returns HTML (scalar values) and authentication is done through session cookie. + Permission Routes: Permission entry for and . + Permission APIs: Permission entry for @@ -25,7 +25,7 @@ Each admin module does have a , therefore configure the class and override the following methods: +You can also setup permissions which are not regulated through , therefore configure the class and override the following methods: ```php public function extendPermissionApis() @@ -76,9 +76,9 @@ The above *module/controller/action* route is now protected by admin UI authoriz There are different controllers which can be extended, but they have different permission systems. Some use `routes` and others take `apis` as permission level. -+ : This is a WEB controller and permission is handled trough `routes`. Those controllers usually return HTML content and not REST responses (like JSON). -+ : The RestController can take `routes` as permission, route validation can be done trough . The controller requies response of array data (JSON response). -+ : The modelClass based ActiveController which implements basic REST behaviors like create,update,view and delete based on a given model. The permission is authorized trough `apis` and the implementation of . ++ : This is a WEB controller and permission is handled through `routes`. Those controllers usually return HTML content and not REST responses (like JSON). ++ : The RestController can take `routes` as permission, route validation can be done through . The controller requies response of array data (JSON response). ++ : The modelClass-based ActiveController which implements basic REST behaviors like create, update, view and delete based on a given model. The permission is authorized through `apis` and the implementation of . ## Custom Actions in REST/API Controllers diff --git a/docs/guide/app/console.md b/docs/guide/app/console.md index f3786fa..cc3fb4c 100644 --- a/docs/guide/app/console.md +++ b/docs/guide/app/console.md @@ -100,9 +100,9 @@ Now you could run the sync command like all other commands with `./vendor/bin/lu ### Views and UrlManger -Its very often case where you like to render a view and send a mail inside a console command, like batch processing some data (newsletter for example). Therefore your views use the class in order to generate urls. +It's very often case where you like to render a view and send a mail inside a console command, like batch processing some data (newsletter for example). Therefore your views use the class in order to generate urls. -As the console command does not know your web server URL and there is no parameter of your web server url, therefore LUYA has a special configuration property called . +As the console command does not know your web server URL and there is no parameter of your web server URL, therefore LUYA has a special configuration property called . This value will be used when defined as base URL for the urlManager. diff --git a/docs/guide/app/filters.md b/docs/guide/app/filters.md index a8b5e3f..d5f8a4b 100644 --- a/docs/guide/app/filters.md +++ b/docs/guide/app/filters.md @@ -84,7 +84,7 @@ Where **139** could be the image `id` from your database source ActiveRecord. If ``` -or you can use the filter name directly which is not recommend as if the filter name change you have to search and replace trough the whole project for the deprecated names. +or you can use the filter name directly which is not recommend as if the filter name change you have to search and replace through the whole project for the deprecated names. ```php diff --git a/docs/guide/app/language.md b/docs/guide/app/language.md index 29746af..d8a45b9 100644 --- a/docs/guide/app/language.md +++ b/docs/guide/app/language.md @@ -1,6 +1,6 @@ # Languages -LUYA provides a powerful multi language support as we have focused on multi-lingual website very strong during the concept and development phase. In order to understand how to configure your site to fit your needs read the section below. +LUYA provides a powerful multi-language support as we have focused on multi-lingual website very strong during the concept and development phase. In order to understand how to configure your site to fit your needs read the section below. Keep in mind that the `language` property of your application is the main setting for the Yii translation system. @@ -41,7 +41,7 @@ There are two ways to retrieve the current active language: > Instead of using the locales system, we recommend you to make usage of the PHP intl extension, which is commonly available. Therefore e.g. you use `Yii::$app->formatter->asDatetime($time, 'MMMM yyyy')` instead of `strftime("%B %Y", $date);`. Take a look at the formating syntax here https://unicode-org.github.io/icu/userguide/format_parse/datetime -As the composition component can override the which is the base property for all translations within a Yii system you can define localisations for each language. Localisation are usually set trough setlocale() this is what LUYA does in the . You can define a localisation file for each language with the property, for example when language `de` is given it should take the `de_CH.utf8` locale file: +As the composition component can override the which is the base property for all translations within a Yii system you can define localisations for each language. Localisation are usually set through `setLocale()` this is what LUYA does in the . You can define a localisation file for each language with the property, for example when language `de` is given it should take the `de_CH.utf8` locale file: ```php 'locales' => [ diff --git a/docs/guide/app/mail.md b/docs/guide/app/mail.md index 73e22e7..9f313b6 100644 --- a/docs/guide/app/mail.md +++ b/docs/guide/app/mail.md @@ -17,7 +17,7 @@ LUYA comes with a component that uses PHPM > Often there are different configuration needed which are depending on your hosting provider. Please have a closer look to to understand how and what can be configured to match the requirements of your email hosting provider. -In order to test your configurations you can run the console command `health/mailer`. The command will try to connect to your mail server trough your provided credentials. By default the mailer component requires a SMTP Server and is not using PHPs mail function. +In order to test your configurations you can run the console command `health/mailer`. The command will try to connect to your mail server through your provided credentials. By default the mailer component requires a SMTP Server and is not using PHPs mail function. ```sh ./vendor/bin/luya health/mailer diff --git a/docs/guide/app/openapi.md b/docs/guide/app/openapi.md index 502f150..0f774bd 100644 --- a/docs/guide/app/openapi.md +++ b/docs/guide/app/openapi.md @@ -140,7 +140,7 @@ The first example will map `POST api-admin-timestamp` to the index action, the s ## OpenAPI Client -In order to consume the OpenAPI trough OpenAPI Client you have to turn off behavior in the for the Admin Module: +In order to consume the OpenAPI through OpenAPI Client you have to turn off behavior in the for the Admin Module: ```php 'admin' => [ diff --git a/docs/guide/app/queue.md b/docs/guide/app/queue.md index 2c34557..4163764 100644 --- a/docs/guide/app/queue.md +++ b/docs/guide/app/queue.md @@ -6,7 +6,7 @@ Since LUYA Admin version 2.0, the ([Yii Queue](https://github.com/yiisoft/yii2-q The component is configured as `adminqueue` based on the Database `yii\queue\db\Queue` integration. -The admin module has a default integration for scheduling jobs when working with selects (dropdowns) and checkbox, so you are able to schedule those changes out of the box! See Checkbox (ToggleStatus) and Select . +The admin module has a default integration for scheduling jobs when working with selects (dropdowns) and checkbox, so you are able to schedule those changes out-of-the-box! See Checkbox (ToggleStatus) and Select . ## Configure to run @@ -30,7 +30,7 @@ The fake cron job will run each 25 minutes whether users request the websites in ] ``` -The fake cronjob won't be executed on console (cli) commands. The information about last run timestamp is stored in with identifier `luya\admin\models\Config::CONFIG_QUEUE_TIMESTAMP`. +The fake cronjob won't be executed on console (CLI) commands. The information about last run timestamp is stored in with identifier `luya\admin\models\Config::CONFIG_QUEUE_TIMESTAMP`. ### Cronjob (admin/queue Command) diff --git a/docs/guide/app/security.md b/docs/guide/app/security.md index d0dfe21..f971228 100644 --- a/docs/guide/app/security.md +++ b/docs/guide/app/security.md @@ -43,7 +43,7 @@ We recommend to enable whi ] ``` -Since admin version 3.0 it's also possible to setup 2FA login with OTP trough any authenticator app. +Since admin version 3.0 it's also possible to setup 2FA login with OTP through any authenticator app. ![LUYA 2FA](../img/2fa.png) @@ -71,7 +71,7 @@ With enabling of the ## JSON response cruft prepend -A JSON vulnerability allows third party website to turn your JSON resource URL into JSONP request under some conditions. To encounter this, the server can prefix all JSON requests with following cruft `")]}',\n"`. This is auto enabled for all JSON responses which are provided by the admin module trough the APIs. +A JSON vulnerability allows third party website to turn your JSON resource URL into JSONP request under some conditions. To encounter this, the server can prefix all JSON requests with following cruft `")]}',\n"`. This is auto enabled for all JSON responses which are provided by the admin module through the APIs. ```php 'admin' => [ diff --git a/docs/guide/app/speed.md b/docs/guide/app/speed.md index b8b5ca8..2abddf2 100644 --- a/docs/guide/app/speed.md +++ b/docs/guide/app/speed.md @@ -16,7 +16,7 @@ You should always enable caching in production! Caching stores data inside the r > When using LUYA deployer, the runtime folder will be recreated for each deployment. You can also force recaching by click the reload button in the admin UI. -There are also a few other caching mechanism available and built in into Yii. See the [supported cache storage](https://www.yiiframework.com/doc-2.0/guide-caching-data.html#supported-cache-storage) +There are also a few other caching mechanism available and built into Yii. See the [supported cache storage](https://www.yiiframework.com/doc-2.0/guide-caching-data.html#supported-cache-storage) ## Page Caching @@ -45,7 +45,7 @@ When dealing with large database tables in your application you should define da > since Admin 3.9 -The admin provides an out of the box table which can be taken to store the session inside the database, thereore just configured: +The admin provides an out-of-the-box table which can be taken to store the session inside the database, thereore just configured: ```php $config->component('session', [ diff --git a/docs/guide/cms/blocks.md b/docs/guide/cms/blocks.md index c900bae..8325c27 100644 --- a/docs/guide/cms/blocks.md +++ b/docs/guide/cms/blocks.md @@ -252,7 +252,7 @@ public function callbackHelloWorld($time) } ``` -The above callback requires the parameter `$time` and must be called trough an AJAX call inside of the JavaScript, to create the URL for this specific callback we are going to use `createAjaxLink()`: +The above callback requires the parameter `$time` and must be called through an AJAX call inside of the JavaScript, to create the URL for this specific callback we are going to use `createAjaxLink()`: ```php $this->createAjaxLink('HellWorld', ['time' => time()]); diff --git a/docs/guide/cms/blocktypes.md b/docs/guide/cms/blocktypes.md index 9cbc71c..427f987 100644 --- a/docs/guide/cms/blocktypes.md +++ b/docs/guide/cms/blocktypes.md @@ -216,7 +216,7 @@ The following Injectors are currently available: ### Injector API -Each injector object generate trough the method can be access trough the magical array access. Let's assume you are registering the TagInjector: +Each injector object generate through the method can be access through the magical array access. Let's assume you are registering the TagInjector: ```php public function injectors() @@ -225,7 +225,7 @@ public function injectors() } ``` -Now you are able to access the TagInjector object trough the `$this['tags']` ArrayAccess getter method. +Now you are able to access the TagInjector object through the `$this['tags']` ArrayAccess getter method. ## Custom Types diff --git a/docs/guide/cms/cmslayouts.md b/docs/guide/cms/cmslayouts.md index 8f7960a..0e853d4 100644 --- a/docs/guide/cms/cmslayouts.md +++ b/docs/guide/cms/cmslayouts.md @@ -37,9 +37,9 @@ In order to provide a JSON, use the same name as for the layout with the ending ```json { - "rows" : [ + "rows": [ [ - {"cols": 8, "var": "left", "label": "Main content Left"}, + {"cols": 8, "var": "left", "label": "Main Content Left"}, {"cols": 4, "var": "right", "label": "Sidebar Right"} ] ] @@ -48,16 +48,16 @@ In order to provide a JSON, use the same name as for the layout with the ending Now the administration area knows how the placeholder columns are structured based on the Bootstrap 4 grid system. The maximum amount of `cols` is 12. -You can also define multiple rows, here an advanced example for a layout with 4 placeholders: +You can also define multiple rows, here is an advanced example for a layout with 4 placeholders: ```json { - "rows" : [ + "rows": [ [ {"cols": 12, "var": "stage", "label": "Stage"} ], [ - {"cols": 8, "var": "left", "label": "Main content"}, + {"cols": 8, "var": "left", "label": "Main Content"}, {"cols": 4, "var": "right", "label": "Sidebar"} ], [ diff --git a/docs/guide/cms/menu.md b/docs/guide/cms/menu.md index 4e6e387..dd97a2d 100644 --- a/docs/guide/cms/menu.md +++ b/docs/guide/cms/menu.md @@ -2,7 +2,7 @@ The component allows you to build website navigations. The menu component is part of the **CMS** module. -You can access the component trough `Yii::$app->menu`. This component help you to create menus, find childs, get items of containers, get property data and much more. The menu component is automatically registered when adding the CMS module to your config. +You can access the component through `Yii::$app->menu`. This component help you to create menus, find childs, get items of containers, get property data and much more. The menu component is automatically registered when adding the CMS module to your config. The menu component is registered automatically in your config, if you need to configure or modify settings the registration of the component looks like this: diff --git a/docs/guide/concepts/depandsync.md b/docs/guide/concepts/depandsync.md index 797dd77..831d63c 100644 --- a/docs/guide/concepts/depandsync.md +++ b/docs/guide/concepts/depandsync.md @@ -81,7 +81,7 @@ Terminal commands: `./vendor/bin/luya admin/proxy` --> run or setup proxy urls and secret token `./vendor/bin/luya admin/proxy/clear` --> clear and reset local stored proxy configuration -In case an error occurs when executing the `admin/proxy` command, executing the `admin/proxy/clear` command first might help (you will have to enter the url, identifier and token after resetting the configuration with the `clear` command). +In case an error occurs when executing the `admin/proxy` command, executing the `admin/proxy/clear` command first might help (you will have to enter the URL, identifier and token after resetting the configuration with the `clear` command). For details and more commands, see . diff --git a/docs/guide/concepts/elements.md b/docs/guide/concepts/elements.md index 6dc7468..6a84643 100644 --- a/docs/guide/concepts/elements.md +++ b/docs/guide/concepts/elements.md @@ -102,7 +102,7 @@ return [ ] ``` -If the styleguide module is successfully configured it is accessible it trough the url: `yourwebsite.com/styleguide` +If the styleguide module is successfully configured it is accessible through the URL: `yourwebsite.com/styleguide` ## Mocking arguments diff --git a/docs/guide/concepts/headless.md b/docs/guide/concepts/headless.md index e0a5409..f3fed07 100644 --- a/docs/guide/concepts/headless.md +++ b/docs/guide/concepts/headless.md @@ -1,6 +1,6 @@ # Headless -As LUYA is built upon the concept of REST APIs, providing headless access to the database content of LUYA is a no brainer. You can either access the [Ngrest](../ngrest/) APIs or the CMS admin APIs. Since LUYA admin version 1.1.0 we've added the ability to create API users and an overview of which endpoints they can request data from: +As LUYA is built upon the concept of REST APIs, providing headless access to the database content of LUYA is a no brainer. You can either access the [NgRest](../ngrest/) APIs or the CMS admin APIs. Since LUYA admin version 1.1.0 we've added the ability to create API users and an overview of which endpoints they can request data from: ![API User overview](../img/api-user-overview.png "API User overview") @@ -14,7 +14,7 @@ With introduction of Headless System a new API User layer has been introduced. A + Request can be tracked in order to debug or find bottlenecks. + Log entries won't be generated by default, as API users might make thousands of entries, depending of the application. + Access tokens can be revereted. -+ API Users are unable to login into the admin area (trough UI) ++ API Users are unable to login into the admin area (through UI) + None, one or more permission groups can be assigned to an API User. ## Admin Data @@ -23,7 +23,7 @@ The [PHP Headless Client](https://github.com/luyadev/luya-headless) is the main ## CMS Bridge -In addition to the existing APIs for the CMS, we have also made a module which exposes all required CMS data to a public API, see the [CMS API Bridge Module](https://github.com/luyadev/luya-headless-cms-api). With this module no authorization process is required and there are APIs which makes it more easy to consume the data instead of gathering the data by yourself trough the OpenAPI description. +In addition to the existing APIs for the CMS, we have also made a module which exposes all required CMS data to a public API, see the [CMS API Bridge Module](https://github.com/luyadev/luya-headless-cms-api). With this module no authorization process is required and there are APIs which makes it more easy to consume the data instead of gathering the data by yourself through the OpenAPI description. ## JWT @@ -42,4 +42,4 @@ If you build a website with the LUYA CMS but use the headless client to render t ] ``` -To extend, improve or speed up your APIs, take a look at [NgRest Api](../ngrest/api) guide section. +To extend, improve or speed up your APIs, take a look at [NgRest API](../ngrest/api) guide section. diff --git a/docs/guide/dev/arguments.md b/docs/guide/dev/arguments.md index efa641f..dc01584 100644 --- a/docs/guide/dev/arguments.md +++ b/docs/guide/dev/arguments.md @@ -13,7 +13,7 @@ ## Technical Advantages + LUYA is based on APIs and can therefore be accessed by any HTTP Client, this is also known as Headless System. -+ API Users can be created to access the Content trough APIs for a certain group or user ++ API Users can be created to access the Content through APIs for a certain group or user + An OpenAPI file can be created on the fly to generate client SDKs or render nice API Documentations. + The Administration Module can be shipped without the CMS, therefore maybe the CMS is not required in your Project and only CRUD with API does the job, so just install the Admin Module. + LUYA Error Module helps you to track errors and gathers them to one place, a must when developing multiple projects. diff --git a/docs/guide/dev/package.md b/docs/guide/dev/package.md index 7f4020a..bdcab7d 100644 --- a/docs/guide/dev/package.md +++ b/docs/guide/dev/package.md @@ -117,7 +117,7 @@ The `composer.json` file can contain an extra section which can be read by the L ## Bootstraping dependencies in dependencies (child dependencies) -Its very common to create a "private" (company specific let' say) repository containing code for several projects and also includes the LUYA requirements like `admin` and `cms`. As LUYA strongly relies on the [LUYA Composer](https://github.com/luyadev/luya-composer) which contains a `bootstrap` section to make more easy to load data when creating extensions and modules this can be a problem when work with child Dependencies (A Dependencies of a Dependencies). +It's very common to create a "private" (company specific let' say) repository containing code for several projects and also includes the LUYA requirements like `admin` and `cms`. As LUYA strongly relies on the [LUYA Composer](https://github.com/luyadev/luya-composer) which contains a `bootstrap` section to make more easy to load data when creating extensions and modules this can be a problem when work with child Dependencies (A Dependencies of a Dependencies). Assuming the following scenario we have a `BaseRepo` and an `ProjectApplication` where the `ProjectApplication` requires the `BaseRepo` as a dependency. diff --git a/docs/guide/frontend/intro.md b/docs/guide/frontend/intro.md index 13f6efd..06e3be2 100644 --- a/docs/guide/frontend/intro.md +++ b/docs/guide/frontend/intro.md @@ -1,6 +1,6 @@ # Frontend Module -If specific logic have to be applied to your website, e.g. a form where user can input data or you may load data from a database and render a custom view then you can create a frontend module. The module can be integrated into your CMS or called directly via the module url. +If specific logic have to be applied to your website, e.g. a form where user can input data or you may load data from a database and render a custom view then you can create a frontend module. The module can be integrated into your CMS or called directly via the module URL. Frontend modules are also a very common way to redistributed logic of a controller but still let the user implement the view files to fit their look. @@ -130,11 +130,11 @@ class DefaultController extends Controller } ``` -Those actions are already accessible by an exact url, because we have a `DefaultController` in our `frontendmodule` most likely the URL for the `actionHello()` is: +Those actions are already accessible by an exact URL, because we have a `DefaultController` in our `frontendmodule` most likely the URL for the `actionHello()` is: `your-public-project-domain/frontendmodule/default/hello` -Please keep in mind that those actions are case sensitive, which means `actionWhoAmI` it is accessible via the url: +Please keep in mind that those actions are case-sensitive, which means `actionWhoAmI` it is accessible via the URL: `your-public-project-domain/frontendmodule/default/who-am-i` diff --git a/docs/guide/frontend/urlrules.md b/docs/guide/frontend/urlrules.md index 9467a85..c8bf128 100644 --- a/docs/guide/frontend/urlrules.md +++ b/docs/guide/frontend/urlrules.md @@ -65,7 +65,7 @@ When you have defined URL rules for your module you may want to use them in your \luya\helpers\Url::toRoute(['/estore/basket/index']); ``` -And a the parameterized route: +And the parameterized route: ```php \luya\helpers\Url::toRoute(['/estore/article/index', 'id' => 123]); @@ -106,7 +106,7 @@ This also means that the given URL rules are available when it's required to poi > When composition is enabled, it will take the correct route for the current language and prefix the pattern if enable in composition config. -To verify which composition language is used you can dump `Yii::$app->composition->langShortCode`. The component is taking care of LUYA multi language websites and is registered by default for all LUYA projects. +To verify which composition language is used you can dump `Yii::$app->composition->langShortCode`. The component is taking care of LUYA multi-language websites and is registered by default for all LUYA projects. ## Retrieve Current Rule in CMS Context diff --git a/docs/guide/installation/index.md b/docs/guide/installation/index.md index 033e090..07d1179 100644 --- a/docs/guide/installation/index.md +++ b/docs/guide/installation/index.md @@ -1,6 +1,6 @@ # Create a LUYA Application -The LUYA installation requires Composer. Please have a look at the [official Composer website](https://getcomposer.org/doc/00-intro.md) if you haven´t installed it on your system yet. +The LUYA installation requires Composer. Please have a look at the [official Composer website](https://getcomposer.org/doc/00-intro.md) if you haven't installed it on your system yet. ::: tip Video See the [installation Video on Youtube](https://www.youtube.com/watch?v=Ybq878PMe_U). @@ -8,7 +8,7 @@ See the [installation Video on Youtube](https://www.youtube.com/watch?v=Ybq878PM ## Create Project -After setting up Composer, we execute the Composer command `create-project` to checkout the [luya-kickstarter](https://github.com/luyadev/luya-kickstarter-bootstrap4) application, an **out of the box** LUYA setup to run your website directly. It is recommended to run the `create-project` command directly from your htdocs/webserver folder like this: +After setting up Composer, we execute the Composer command `create-project` to checkout the [luya-kickstarter](https://github.com/luyadev/luya-kickstarter-bootstrap4) application, an **out-of-the-box** LUYA setup to run your website directly. It is recommended to run the `create-project` command directly from your htdocs/webserver folder like this: ```sh composer create-project luyadev/luya-kickstarter:^1.0 @@ -34,7 +34,7 @@ cp env.php.dist env.php > On Windows use: `copy env.php.dist env.php` -Now the database connection inside the `configs/config.php` file needs to fit your MySQL servers' configuration. It is recommended to open all config files once to change values and understand the behavior. In order to understand the config files, read more in the [environment configs section](/guide/installation/environments.html). +Now the database connection inside the `configs/config.php` file needs to fit your MySQL server configuration. It is recommended to open all config files once to change values and understand the behavior. In order to understand the config files, read more in the [environment configs section](/guide/installation/environments.html). ## Migrate and Import diff --git a/docs/guide/installation/problems.md b/docs/guide/installation/problems.md index b1cd3a5..3060e72 100644 --- a/docs/guide/installation/problems.md +++ b/docs/guide/installation/problems.md @@ -15,7 +15,7 @@ In order to fix this, make sure you have the same default language short code in ## Admin Module Logout after Login -If there are random logouts, or immediate logouts after, this is either a problem of being behind a loadbalancer, the ip changes a lot or a problem with the webserver: +If there are random logouts, or immediate logouts after, this is either a problem of being behind a load balancer, the IP changes a lot or a problem with the webserver: + Disabled in your admin module config, see [example config](structure#configuration-files-and-config-builder) + Disabled secure connection check , see [example config](structure#configuration-files-and-config-builder) diff --git a/docs/guide/installation/structure.md b/docs/guide/installation/structure.md index 4d9646b..39d39c9 100644 --- a/docs/guide/installation/structure.md +++ b/docs/guide/installation/structure.md @@ -62,7 +62,7 @@ $config = new Config('myproject', dirname(__DIR__), [ 'secureLogin' => false, // when enabling secure login, the mail component must be proper configured otherwise the auth token mail will not send. 'strongPasswordPolicy' => false, // If enabled, the admin user passwords require strength input with special chars, lower, upper, digits and numbers 'interfaceLanguage' => 'en', // Admin interface default language. - 'autoBootstrapQueue' => true, // Enables the fake cronjob by default, read more about queue/scheduler: https://luya.io/guide/app-queue + 'autoBootstrapQueue' => true, // Enables the fake cronjob by default, read more about queue/scheduler: https://luya.io/guide/app/queue 'logoutOnUserIpChange' => true, ], 'cms' => [ @@ -253,7 +253,7 @@ return $config->toArray(\luya\Config::ENV_PROD); ## Company wide config -Its very common that you like to share configuration values over different projects, therefore we encourage you to create your own LUYA DI repo, create a private repository on your VCS platform (example GitHub) add a Bootstrap file like: +It's very common that you like to share configuration values over different projects, therefore we encourage you to create your own LUYA DI repo, create a private repository on your VCS platform (example GitHub) add a bootstrap file like: ```php ``` -Its very common to just write the AngularJS controller code inside the view, of course you can also make a JavaScript file and add this to an asset and register the [[/guide/admin/assets]]. +It's very common to just write the AngularJS controller code inside the view, of course you can also make a JavaScript file and add this to an asset and register the [[/guide/admin/assets]]. diff --git a/docs/guide/lessons/imagesliderblock.md b/docs/guide/lessons/imagesliderblock.md index cdd2aa4..b8cb4db 100644 --- a/docs/guide/lessons/imagesliderblock.md +++ b/docs/guide/lessons/imagesliderblock.md @@ -20,7 +20,7 @@ This will automatically create an pre filled `ImagesliderBlock.php` in our **blo ## Register an external JavaScript and CSS file -As LUYA is build upon Yii 2, we can use the built in asset system. We register external JS files like [shown in the Yii guide](https://www.yiiframework.com/doc-2.0/guide-output-client-scripts.html#script-files) in the beginning of the view file: +As LUYA is built upon Yii 2, we can use the built in asset system. We register external JS files like [shown in the Yii guide](https://www.yiiframework.com/doc-2.0/guide-output-client-scripts.html#script-files) in the beginning of the view file: ```php When creating an open source module, you should provide frontend views which the developer then could trough `useAppViewPath` or not. +> When creating an open source module, you should provide frontend views which the developer then could through `useAppViewPath` or not. ## Creating the models and migrations Our first step for the creation of our data model and the migration files is to create the associated database tables. -Again, we're using the code wizard to [create the migration file](https://luya.io/guide/ngrest-concept) for our registered admin module **addressbookadmin**. We will need two tables, one for the contact data itself and one for the different contact groups. +Again, we're using the code wizard to [create the migration file](https://luya.io/guide/ngrest) for our registered admin module **addressbookadmin**. We will need two tables, one for the contact data itself and one for the different contact groups. ```sh ./vendor/bin/luya migrate/create addressbook_basetables addressbookadmin @@ -160,7 +160,7 @@ Before we will see the module in the admin view, we have to set the permissions ## Linking the group table in the contact table -We do not want to put the group ID in a contact record. In order to get a nice dropdown with all available `Groups`, we have to modify the `ngRestAttributeTypes()` function in the `Contact.php` model. We will use the [selectModel](https://luya.io/guide/ngrest-plugin-select) attribute type for the field `group_id`. +We do not want to put the group ID in a contact record. In order to get a nice dropdown with all available `Groups`, we have to modify the `ngRestAttributeTypes()` function in the `Contact.php` model. We will use the [selectModel](https://luya.io/guide/ngrest/plugin-select) attribute type for the field `group_id`. Our `ngRestAttributeTypes()` function should look like this: diff --git a/docs/guide/ngrest/activebutton.md b/docs/guide/ngrest/activebutton.md index e13fe4f..e900ec3 100644 --- a/docs/guide/ngrest/activebutton.md +++ b/docs/guide/ngrest/activebutton.md @@ -51,11 +51,11 @@ class DuplicateActiveButton extends ActiveButton The handle method must return or in order to make a correct API response to the grid view. -Als you can trigger events for certain situations. Assuming you are going to modify the value of a column inside this CRUD, a forced reload of the CRUD list can be done trough . +Als you can trigger events for certain situations. Assuming you are going to modify the value of a column inside this CRUD, a forced reload of the CRUD list can be done through . ## Attaching the Button -An Active Button can be attached inside every model trough the method. +An Active Button can be attached inside every model through the method. ```php public function ngRestActiveButtons() diff --git a/docs/guide/ngrest/activeselection.md b/docs/guide/ngrest/activeselection.md index c6322ec..88008e5 100644 --- a/docs/guide/ngrest/activeselection.md +++ b/docs/guide/ngrest/activeselection.md @@ -1,6 +1,6 @@ # Active Selections - are analog to [Active Buttons](activebutton.md). When are defined, checkboxes will appear in the CRUD list (overview of all records) and a the active selection buttons are visible in the bottom. A click on the button interacts with the selected items/rows. + are analog to [Active Buttons](activebutton.md). When are defined, checkboxes will appear in the CRUD list (overview of all records) and the Active Selection buttons are visible in the bottom. A click on the button interacts with the selected items/rows. There are built in Active Selections you can use and configure or you can create your own Active Selections and attach them to an [NgRestModel](model.md) diff --git a/docs/guide/ngrest/activewindow.md b/docs/guide/ngrest/activewindow.md index 5d3fff3..b419cae 100644 --- a/docs/guide/ngrest/activewindow.md +++ b/docs/guide/ngrest/activewindow.md @@ -137,7 +137,7 @@ public function callbackPostData($firstname, $lastname) ## AngularJS in view files -As the admin UI is written in AngularJS which let´s you easily create inline AngularJS controllers to interact with your Active Window class. The below view file shows an AngularJS controller which collects data from the controller assigned into the view but uses `ng-repeat to display and render the data. +As the admin UI is written in AngularJS which lets you easily create inline AngularJS controllers to interact with your Active Window class. The below view file shows an AngularJS controller which collects data from the controller assigned into the view but uses `ng-repeat` to display and render the data. ```js