diff --git a/docker-compose.yml b/docker-compose.yml index e819e1b4c539e3588496bf67f53a5dc9e2b1ed04..a42fbacff48f597c50f9d0c8c52b4e02faec392e 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,9 +1,7 @@ -version: '3.7' - services: mkdocs: container_name: mkdocs - image: registry.lakedrops.com/docker/mkdocs:1.6.0 + image: registry.lakedrops.com/docker/mkdocs:1.6.0.1 restart: unless-stopped ports: - 8999:8000 diff --git a/docs/eca/extend/modules.md b/docs/eca/extend/modules.md index 2d9fa61fb3b9a937bc70d0c3899d4fc178196dc6..b0e93084e4fc86bbd2606d82a4d83c0c20f68a22 100644 --- a/docs/eca/extend/modules.md +++ b/docs/eca/extend/modules.md @@ -7,19 +7,19 @@ title: Modules extending ECA ### Providing ECA functionality -- ECA Access: Events and actions to control access on entities and fields - [plugins](/plugins/eca/access) -- ECA Base: Base events, conditions and actions - [plugins](/plugins/eca/base) -- ECA Cache: Actions to read, write or invalidate cache items - [plugins](/plugins/eca/cache) -- ECA Config: Config events - [plugins](/plugins/eca/config) -- ECA Content: Content entity events, conditions and actions - [plugins](/plugins/eca/content) -- ECA Form: Form API events, conditions and actions - [plugins](/plugins/eca/form) -- ECA Log: Events and actions for Drupal log messages - [plugins](/plugins/eca/log) -- ECA Migrate: Migrate events - [plugins](/plugins/eca/migrate) -- ECA Misc: Miscellaneous events and conditions from Drupal core and the kernel - [plugins](/plugins/eca/misc) -- ECA Queue: Events, conditions and actions for queued operations. - [plugins](/plugins/eca/queue) -- ECA User: User events, conditions and actions - [plugins](/plugins/eca/user) -- ECA Views: Execute and export Views query results within ECA - [plugins](/plugins/eca/views) -- ECA Workflow: Content entity workflow actions - [plugins](/plugins/eca/workflow) +- ECA Access: Events and actions to control access on entities and fields - [plugins](/plugins/eca/access/index.md) +- ECA Base: Base events, conditions and actions - [plugins](/plugins/eca/base/index.md) +- ECA Cache: Actions to read, write or invalidate cache items - [plugins](/plugins/eca/cache/index.md) +- ECA Config: Config events - [plugins](/plugins/eca/config/index.md) +- ECA Content: Content entity events, conditions and actions - [plugins](/plugins/eca/content/index.md) +- ECA Form: Form API events, conditions and actions - [plugins](/plugins/eca/form/index.md) +- ECA Log: Events and actions for Drupal log messages - [plugins](/plugins/eca/log/index.md) +- ECA Migrate: Migrate events - [plugins](/plugins/eca/migrate/index.md) +- ECA Misc: Miscellaneous events and conditions from Drupal core and the kernel - [plugins](/plugins/eca/misc/index.md) +- ECA Queue: Events, conditions and actions for queued operations. - [plugins](/plugins/eca/queue/index.md) +- ECA User: User events, conditions and actions - [plugins](/plugins/eca/user/index.md) +- ECA Views: Execute and export Views query results within ECA - [plugins](/plugins/eca/views/index.md) +- ECA Workflow: Content entity workflow actions - [plugins](/plugins/eca/workflow/index.md) ### Others @@ -28,16 +28,16 @@ title: Modules extending ECA ## Drupal contrib modules -- [ECA Context](https://www.drupal.org/project/eca_context) - [plugins](/plugins/eca/context) +- [ECA Context](https://www.drupal.org/project/eca_context) - [plugins](/plugins/eca/context/index.md) - [ECA Entity Share](https://www.drupal.org/project/eca_entity_share) - - Client - [plugins](/plugins/eca/entity_share_client) - - Server - [plugins](/plugins/eca/entity_share_server) -- [ECA Parameters](https://www.drupal.org/project/eca_parameters) - [plugins](/plugins/eca/parameters) -- [ECA State Machine](https://www.drupal.org/project/eca_state_machine) - [plugins](/plugins/eca/state_machine) -- [ECA Tamper](https://www.drupal.org/project/eca_tamper) - [plugins](/plugins/eca/tamper) -- [ECA VBO](https://www.drupal.org/project/eca_vbo) - [plugins](/plugins/eca/vbo) -- [ECA Webform](https://www.drupal.org/project/eca_webform) - [plugins](/plugins/eca/webform) -- [Group Actions](https://www.drupal.org/project/group_action) - [plugins](/plugins/group_action) + - Client - [plugins](/plugins/eca/entity_share_client/index.md) + - Server - [plugins](/plugins/eca/entity_share_server/index.md) +- [ECA Parameters](https://www.drupal.org/project/eca_parameters) - [plugins](/plugins/eca/parameters/index.md) +- [ECA State Machine](https://www.drupal.org/project/eca_state_machine) - [plugins](/plugins/eca/state_machine/index.md) +- [ECA Tamper](https://www.drupal.org/project/eca_tamper) - [plugins](/plugins/eca/tamper/index.md) +- [ECA VBO](https://www.drupal.org/project/eca_vbo) - [plugins](/plugins/eca/vbo/index.md) +- [ECA Webform](https://www.drupal.org/project/eca_webform) - [plugins](/plugins/eca/webform/index.md) +- [Group Actions](https://www.drupal.org/project/group_action) - [plugins](/plugins/group_action/index.md) ### Hopefully in development diff --git a/docs/eca/troubleshooting.md b/docs/eca/troubleshooting.md index 18a748f13f86c807855981fa4b03730467e06bf6..b5e58aa170898e53aa8d71f73308049274b6ebc6 100644 --- a/docs/eca/troubleshooting.md +++ b/docs/eca/troubleshooting.md @@ -57,7 +57,7 @@ anymore. ## Workflow transition sometimes not recognized When using the workflows module from Drupal core together with content moderation, then the event -[Workflow: state transition](/plugins/eca/workflow/events/workflow_transition) may not recognize +[Workflow: state transition](/plugins/eca/workflow/events/workflow_transition.md) may not recognize the changed state, because the pre-save method in Drupal core may load the wrong revision under certain circumstances. diff --git a/docs/eca/usage.md b/docs/eca/usage.md index 0be22553124fa302de425be0c10056101e6d9ee0..db7e3e0be0e7853964c68f7265e2678bdaab2082 100644 --- a/docs/eca/usage.md +++ b/docs/eca/usage.md @@ -10,7 +10,7 @@ models !!! attention Should there ever be a problem, that ECA breaks your site, please refer to the - [troubleshooting](/eca/troubleshooting) section which explains how to fix that. + [troubleshooting](/eca/troubleshooting.md) section which explains how to fix that. ## How it works @@ -85,7 +85,7 @@ below. The ECA admin UI does not provide you access to create new models or ti edit existing ones. Those actions are only available, when at least one modeller is enabled which provides support for integrated editing, like e.g. the - [bpmn.io modeller](/modeller/bpmn/bpmn_io). + [bpmn.io modeller](/modeller/bpmn/bpmn_io/index.md). ### Settings @@ -95,7 +95,7 @@ below. Determines, which ECA log messages will be logged to which ever logging backend is enabled on your site. By default, ECA only logs errors or more severe log messages. You can change that to e.g. `Debug` to also get much more detailed - logs, see also [Logs](#logs) and [Debugging](/eca/debugging). + logs, see also [Logs](#logs) and [Debugging](/eca/debugging.md). `Documentation domain` @@ -113,7 +113,7 @@ content and/or time range and the list is sorted in exactly that order how the m Each log message for a condition or an action will also contain a list of tokens, that have been available at the time when that component has been evaluated or executed. For more details about token, see -[Concepts: Token](/eca/concepts/tokens). +[Concepts: Token](/eca/concepts/tokens.md). ### ECA model operations @@ -123,7 +123,7 @@ Drupal site: #### Creating and editing models These actions are only available, if you have a modeller enebaled that supports integrated editing, like e.g. the -[bpmn.io modeller](/modeller/bpmn/bpmn_io). +[bpmn.io modeller](/modeller/bpmn/bpmn_io/index.md). #### Import and export models @@ -132,7 +132,7 @@ select a file to import. There are actually 2 different file types supported for - an `eca.model.[MODEL-ID].yml` config file, see [ECA model config files](#eca-model-config-files) - an archive file (e.g. `[MODELLER-TYPE]-[MODEL-ID].tar.gz`) which has been previously exported (see below) or - downloaded from the [Library](/library) + downloaded from the [Library](/library/index.md) Once you've selected the file and click on the `Import` button, ECA will validate the file and if all dependencies are available, import the model and show it on the list of models for further operations. diff --git a/docs/index.md b/docs/index.md index f2e4e440e520922797192f5399847f6561914fb5..d6df4836d1cc794574794fb233c47a94ee5a61db 100644 --- a/docs/index.md +++ b/docs/index.md @@ -13,8 +13,8 @@ It's a [Drupal](https://www.drupal.org) module and has its own [project page](ht ### ECA -[All about the ECA](/) module, [how to install](eca/install) it, [important concepts](eca/concepts) to understand -how ECA works and instructions on [how to extend ECA](eca/extend). +[All about the ECA](/index.md) module, [how to install](eca/install.md) it, [important concepts](eca/concepts/index.md) to understand +how ECA works and instructions on [how to extend ECA](eca/extend/index.md). Important building blocks of ECA are the plugins for events, conditions and actions. Those are contained in their own section for [plugins](#plugins) @@ -36,16 +36,16 @@ extended by other modules. ### Modellers -[Modellers](modeller) are the UI for ECA. They are described in this chapter. +[Modellers](modeller/index.md) are the UI for ECA. They are described in this chapter. ### Plugins -Each event, each condition and each action is available as a [plugin](plugins). This chapter contains documentation +Each event, each condition and each action is available as a [plugin](plugins/index.md). This chapter contains documentation for each of them and how they can be configured. ### Library -This is where you can find [example ECA models](library). +This is where you can find [example ECA models](library/index.md). ### Resources diff --git a/docs/library/index.md b/docs/library/index.md index 9adfcefa21f6d3c8ef9ed640cce757c6a8cc352c..0017516fc74b38f3fddf51cfb53e3491713b9928 100644 --- a/docs/library/index.md +++ b/docs/library/index.md @@ -19,7 +19,7 @@ make your submission qualify for review. All components of the model need to be in English, i.e. not only the meta data but also the labels and variable names in the model itself. -The model needs to be built with the [bpmn_io modeller](/modeller/bpmn/bpmn_io) because those can later be imported in +The model needs to be built with the [bpmn_io modeller](/modeller/bpmn/bpmn_io/index.md) because those can later be imported in either modeller on Drupal sites. ### Meta Data @@ -67,7 +67,7 @@ what's changed in that respective version. ### Dependencies -Building ECA models creates dependencies, i.e. listening to the [Presave content entity](/plugins/eca/content/events/content_entity_presave) +Building ECA models creates dependencies, i.e. listening to the [Presave content entity](/plugins/eca/content/events/content_entity_presave.md) event with the type field being set to a specific node type will make that model dependent on that content type and bundle. Preparing the model for the ECA Guide, ECA will include all required config entities into the exported archive that will be made available for download and import into other sites. diff --git a/docs/library/simple/eca_and_http_services.md b/docs/library/simple/eca_and_http_services.md index 2960c60116014f5b2f24d6ff9e27533e8200fc36..d62988ca925da4174656a5f4afe4d1372ae3f0af 100644 --- a/docs/library/simple/eca_and_http_services.md +++ b/docs/library/simple/eca_and_http_services.md @@ -46,7 +46,6 @@ The creation of this module was recorded and the video with additional explanati ### Actions -- [Receive all posts](/plugins/http_client_manager/actions/http_client_manager_preconfigured_request_all_posts.md) - [Store result in a token](/plugins/eca/base/actions/eca_privatetempstore_read.md) - [Print result](/plugins/core/actions/action_message_action.md) - [allow access](/plugins/eca/access/actions/eca_access_set_result.md) diff --git a/docs/resources/articles/index.md b/docs/resources/articles/index.md index 7935bf72dba08ab66b723243555930fe30a8d09a..93086fdc9cb01335cfdd75abba59ddead5201029 100644 --- a/docs/resources/articles/index.md +++ b/docs/resources/articles/index.md @@ -7,7 +7,7 @@ tags: Here we collect useful links around the ECA ecosystem. -If you have a link that should be added, please follow instructions at [How to contribute](/#how-to-contribute). +If you have a link that should be added, please follow instructions at [How to contribute](/index.md#how-to-contribute). ## Blog Posts diff --git a/docs/resources/index.md b/docs/resources/index.md index 0cfb10c2e29c00012528d2bf6f8d408eb898a359..9c1013cf2bdf07ab1fb95a8fa44035f5d0cd3377 100644 --- a/docs/resources/index.md +++ b/docs/resources/index.md @@ -11,7 +11,7 @@ Here you can find a growing number of articles, tutorial and videos. We also mai [channel on PeerTube](https://tube.tchncs.de/c/eca/videos), where you can subscribe, get notified and comment on all videos. If you have an article, tutorial or video that should be added, please follow instructions at -[How to contribute](/#how-to-contribute). +[How to contribute](/index.md#how-to-contribute). ## Logos diff --git a/docs/resources/tutorials/btown-1.md b/docs/resources/tutorials/btown-1.md index a62fa79d19b4f1012e9a5d7202726fd1ca6e9487..82a965ed9ce69e4b73ffa6a8c8e031cdab4259a4 100644 --- a/docs/resources/tutorials/btown-1.md +++ b/docs/resources/tutorials/btown-1.md @@ -243,4 +243,4 @@ Same as step 18 but not negated. ## Download -This ECA model is [available for download](/library/use%20case/user_network_changes). +This ECA model is [available for download](/library/use case/user_network_changes.md). diff --git a/docs/resources/tutorials/mherchel-1.md b/docs/resources/tutorials/mherchel-1.md index 78a7315e9fb0ceca582b44ef46fa0cc319c03317..588d8f94d083b9f8f467cf8b870fcc08d15c0793 100644 --- a/docs/resources/tutorials/mherchel-1.md +++ b/docs/resources/tutorials/mherchel-1.md @@ -37,7 +37,7 @@ extremely complex things that would normally require custom code. Much like Views UI, the UI of ECA takes a bit of getting used to, but once you’re familiar with it, you can work pretty effectively! -That all being said, there is plenty of [documentation](/), and the maintainers are extremely responsive and helpful +That all being said, there is plenty of [documentation](/index.md), and the maintainers are extremely responsive and helpful within the #eca channel within Drupal Slack. ## Downloading ECA and BPMN.iO diff --git a/include/modules/eca_form.md b/include/modules/eca_form.md index 6937f0bb13526c83398e5fd319a8950189b505a5..6d5151bbf5c76e09d8ce5b3a4e7e832df3f90727 100644 --- a/include/modules/eca_form.md +++ b/include/modules/eca_form.md @@ -19,7 +19,7 @@ This module allows to change and extend any existing form. Examples: - Make the form a multistep worflow - Optionally with ajax - Build up custom forms from scratch - - This ability requires the [ECA Render](/plugins/eca/render/) module to be installed. + - This ability requires the [ECA Render](/plugins/eca/render/index.md) module to be installed. ## Usage @@ -75,14 +75,14 @@ Typical triggers of form validation and submission are Form events are mostly useful to change the output, and to extend validation and submission behavior of an existing form. Whenever data is coming from form input that needs to be processed, form events may help to achieve this. -Furthermore, new custom forms can be created by using actions of the [ECA Render](/plugins/eca/render/) module, +Furthermore, new custom forms can be created by using actions of the [ECA Render](/plugins/eca/render/index.md) module, specifically the action "Render: custom form" is meant for such use case. When it's about adding or changing data of a content entity in general, events of -the [ECA Content](/plugins/eca/content/) may be more suitable and preferred over form events. Specifically events such -as [Presave content entity](/plugins/eca/content/events/content_entity_presave), -[Insert content entity](/plugins/eca/content/events/content_entity_insert) and -[Update content entity](/plugins/eca/content/events/content_entity_update) may be considered. +the [ECA Content](/plugins/eca/content/index.md) may be more suitable and preferred over form events. Specifically events such +as [Presave content entity](/plugins/eca/content/events/content_entity_presave.md), +[Insert content entity](/plugins/eca/content/events/content_entity_insert.md) and +[Update content entity](/plugins/eca/content/events/content_entity_update.md) may be considered. ### How to configure a form event @@ -116,22 +116,22 @@ validation. This layer should only be used to validate form input. #### Reading and working with submitted form input -On simple forms, using the action [Form field: get submitted value](/plugins/eca/form/actions/eca_form_field_get_value) +On simple forms, using the action [Form field: get submitted value](/plugins/eca/form/actions/eca_form_field_get_value.md) can be helpful. But for complex forms, such as of a content entity, it may be hard to get any targeted form input value using this action. When the form is about a certain content entity, such an entity can be build up using the action -[Entity form: build entity](/plugins/eca/form/actions/eca_form_build_entity). With that mechanic, one can directly -work with an entity, reading and setting field values with actions provided by the [ECA Content](/plugins/eca/content/) +[Entity form: build entity](/plugins/eca/form/actions/eca_form_build_entity.md). With that mechanic, one can directly +work with an entity, reading and setting field values with actions provided by the [ECA Content](/plugins/eca/content/index.md) module. #### Hiding form fields It is possible to hide a form field by using the -action [Form field: set access](/plugins/eca/form/actions/eca_form_field_access). It should be +action [Form field: set access](/plugins/eca/form/actions/eca_form_field_access.md). It should be noted though, that such instruction is only about display logic in a specific form. Many times however, it is about a real access issue. For example, certain users may never be allowed to see a certain field of a content entity. For such -case, using components of the [ECA Access](/plugins/eca/access/) module is more advisable. Setting up field access using +case, using components of the [ECA Access](/plugins/eca/access/index.md) module is more advisable. Setting up field access using ECA Access, it makes sure a user will never be able to access a certain field, which includes form displays. ### Examples -- [Content validation](/library/forms/content_validation) +- [Content validation](/library/forms/content_validation.md) diff --git a/include/plugins/_generic/object.md b/include/plugins/_generic/object.md index 8ac295a41f11214d2329a97fc4230af620cc4b26..8dd953f98b3da211de533e79ba931ae7742b02a4 100644 --- a/include/plugins/_generic/object.md +++ b/include/plugins/_generic/object.md @@ -1 +1 @@ -See also: [Tokens being forwarded](/eca/concepts/tokens/#tokens-being-forwarded) +See also: [Tokens being forwarded](/eca/concepts/tokens.md#tokens-being-forwarded) diff --git a/include/plugins/eca_endpoint/event/eca_endpoint_response.md b/include/plugins/eca_endpoint/event/eca_endpoint_response.md index 0aa48010efe8325a5b2bb333a56fc7dc811c6b3d..ccaa0baa1cfd3b019334ace41123ebae3d7b3d9d 100644 --- a/include/plugins/eca_endpoint/event/eca_endpoint_response.md +++ b/include/plugins/eca_endpoint/event/eca_endpoint_response.md @@ -1,9 +1,9 @@ !!! attention - Don't forget to also add an [ECA Endpoint access](/plugins/eca/endpoint/events/eca_endpoint_access) + Don't forget to also add an [ECA Endpoint access](/plugins/eca/endpoint/events/eca_endpoint_access.md) to your model, so that you can allow this endpoint to be requested, unless you determine that by some other means. - It's likely that you will need the [Set access result](/plugins/eca/access/actions/eca_access_set_result) + It's likely that you will need the [Set access result](/plugins/eca/access/actions/eca_access_set_result.md) for this, which is available from the ECA Access sub-module, that needs to be enabled separately. diff --git a/include/plugins/eca_workflow/event/workflow_transition.md b/include/plugins/eca_workflow/event/workflow_transition.md index 815cbcfcd4a549c8d1eaa016f52a860042cbc753..a5521e9f7599fefc756741b69a420cd15d077adf 100644 --- a/include/plugins/eca_workflow/event/workflow_transition.md +++ b/include/plugins/eca_workflow/event/workflow_transition.md @@ -1,4 +1,4 @@ !!! warning "Drupal core bug prevents transition recognition under certain circumstances" For more details, there is a workaround available which is described in the - [Troubleshooting Section](/eca/troubleshooting#workflow-transition-sometimes-not-recognized) + [Troubleshooting Section](/eca/troubleshooting.md#workflow-transition-sometimes-not-recognized)