diff --git a/README.md b/README.md index ebd583b7e0..043dd37fc0 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # Luigi

-

+

## Overview @@ -57,7 +57,6 @@ import { } from '@luigi-project/client-ie11'; ``` - > **NOTE**: The example applications are not fully compatible with IE11. ## Development @@ -72,7 +71,6 @@ For security reasons, follow these guidelines when developing a micro frontend: - Maintain a whitelist with trusted domains and compare it with the origin of the Luigi Core application. The origin will be passed when you call the init listener in your micro frontend. Stop further processing if the origin does not match. - > **NOTE**: Luigi follows these [sandbox rules for iframes](https://github.com/SAP/luigi/blob/af1deebb392dcec6490f72576e32eb5853a894bc/core/src/utilities/helpers/iframe-helpers.js#L140). diff --git a/docs/advanced-scenarios.md b/docs/advanced-scenarios.md index cd55f91a96..2cc836fa75 100644 --- a/docs/advanced-scenarios.md +++ b/docs/advanced-scenarios.md @@ -35,7 +35,7 @@ If you are running Luigi Core v0.7.7+, you can use [fromClosestContext](luigi-cl 1. Configure the Luigi navigation node: - + > **NOTE**: To keep the example simple, we use [virtualTree](navigation-parameters-reference.md#virtualtree) to allow any nested navigation, but this is not mandatory. You can always specify the node tree yourself and still use automatic navigation with router events. diff --git a/docs/authorization-configuration.md b/docs/authorization-configuration.md index b541ef24bb..50853db1b4 100644 --- a/docs/authorization-configuration.md +++ b/docs/authorization-configuration.md @@ -72,7 +72,7 @@ anonymousAccess: true // always show nodes ## OpenID Connect configuration -This code snippet demonstrates how to configure authorization using OpenID Connect in Luigi. Note that you must install the [OpenID Plugin](https://github.com/SAP/luigi/tree/master/plugins/auth/public/auth-oidc) first. +This code snippet demonstrates how to configure authorization using OpenID Connect in Luigi. Note that you must install the [OpenID Plugin](https://github.com/SAP/luigi/tree/master/plugins/auth/public/auth-oidc) first. ```javascript import oidcProvider from '@luigi-project/plugin-auth-oidc'; @@ -224,7 +224,7 @@ After authorization is successful on the authorization provider's side, it redir ​ [openIdConnect.js](../core/src/providers/auth/openIdConnect.js) lazy loads the official `oidc-client` library and is a good starting point if you also depend on external authorization libraries. - + > **NOTE:** Read more about authorization helpers in the [Core API: AuthorizationStore](luigi-core-api.md#AuthorizationStore) section. ​ ### Persisting auth data diff --git a/docs/navigation-advanced.md b/docs/navigation-advanced.md index a81153e19a..3dc54ad8ef 100644 --- a/docs/navigation-advanced.md +++ b/docs/navigation-advanced.md @@ -214,6 +214,7 @@ The purpose of contexts is to send objects to the micro frontend. You can do thi - **type**: object - **description**: sends the specified object as context to the view. Use this property in combination with the dynamic **pathSegment** to receive the context through the context listeners of Luigi Client. This is an alternative to using the dynamic value in the **viewUrl**. + > **NOTE**: Context should not be used to create the path or URL as this can lead to errors. Please use one of the methods described in the [dynamically changeable paths](#dynamically-changeable-paths) section instead. diff --git a/test/e2e-test-application/README.md b/test/e2e-test-application/README.md index 490e7e625d..afe0d02b29 100644 --- a/test/e2e-test-application/README.md +++ b/test/e2e-test-application/README.md @@ -4,7 +4,6 @@ This is the Angular-based sample application which runs with Luigi framework. - > **NOTE:** The authorization flow `mockAuth` in this application is a mock implementation for local development. **DO NOT USE IN PRODUCTION!** ## Development @@ -40,8 +39,8 @@ To have this application running, follow these steps: - To run Luigi with hash-based routing, set the **routing.useHashrouting** configuration to `true`. - To run Luigi with path-based routing, set the **routing.useHashrouting** configuration to `false`. - - Run the server with the following command: + + Run the server with the following command: ```bash npm run start ``` @@ -50,13 +49,13 @@ To have this application running, follow these steps: 6. Optional: Reflect the changes introduced to the Luigi Core code in the sample application. - - Allow the Luigi Core to bundle every change you apply to it. The easiest approach is to open the Luigi `root` folder in another tab of your terminal window and run the following command: - - ```bash + - Allow the Luigi Core to bundle every change you apply to it. The easiest approach is to open the Luigi `root` folder in another tab of your terminal window and run the following command: + + ```bash lerna run bundle-develop ``` - The Luigi Client is not bundled, so you can update it without bundling. - + - The auto-reload of your application updates only the application. Type `CMD + R` to reflect the changes in the linked Luigi Core and Luigi Client modules on the website.