Skip to content

Commit

Permalink
Mixed styles of note and tip in docu (SAP#1231)
Browse files Browse the repository at this point in the history
* change note metadata in docu
  • Loading branch information
alexandra-simeonova authored Apr 8, 2020
1 parent 738f428 commit fc9186e
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 13 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Luigi
<p align="center">
<img src="https://raw.githubusercontent.com/sap/luigi/master/logo.png" width="235">
</p>
</p>

## Overview

Expand Down Expand Up @@ -57,7 +57,6 @@ import {
} from '@luigi-project/client-ie11';
```

<!-- add-attribute:class:warning -->
> **NOTE**: The example applications are not fully compatible with IE11.
## Development
Expand All @@ -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.


<!-- add-attribute:class:success -->
> **NOTE**: Luigi follows these [sandbox rules for iframes](https://github.com/SAP/luigi/blob/af1deebb392dcec6490f72576e32eb5853a894bc/core/src/utilities/helpers/iframe-helpers.js#L140).

Expand Down
2 changes: 1 addition & 1 deletion docs/advanced-scenarios.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

<!-- add-attribute:class:success -->
<!-- add-attribute:class:warning -->
> **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.

Expand Down
4 changes: 2 additions & 2 deletions docs/authorization-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down Expand Up @@ -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.
<!-- add-attribute:class:success -->
<!-- add-attribute:class:warning -->
> **NOTE:** Read more about authorization helpers in the [Core API: AuthorizationStore](luigi-core-api.md#AuthorizationStore) section.
### Persisting auth data
Expand Down
1 change: 1 addition & 0 deletions docs/navigation-advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**.

<!-- add-attribute:class:warning -->
> **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.

Expand Down
13 changes: 6 additions & 7 deletions test/e2e-test-application/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

This is the Angular-based sample application which runs with Luigi framework.

<!-- add-attribute:class:success -->
> **NOTE:** The authorization flow `mockAuth` in this application is a mock implementation for local development. **DO NOT USE IN PRODUCTION!**
## Development
Expand Down Expand Up @@ -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
```
Expand All @@ -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.


Expand Down

0 comments on commit fc9186e

Please sign in to comment.