Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Luigi documentation refinements #80

Merged
5 commits merged into from Sep 14, 2018
Merged

Luigi documentation refinements #80

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3ab739b
Documentation refinements
Sep 14, 2018
93870c3
Put back correct code example lines
Sep 14, 2018
3ac3bde
Correct sentence format, etc.
Sep 14, 2018
b29829c
Capitalization and sentence rewording.
Sep 14, 2018
b530b93
Merge branch 'master' into luigi_docu_refinements
Sep 14, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 16 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,35 @@

## Overview

Luigi is a micro front-end JavaScript framework that enables the creation of an administrative dashboard which is driven by local and distributed views. Luigi enables the communication between a web application and content-views which the application contains such as routing, navigation, authorization, and user experience elements.
Luigi is a micro front-end JavaScript framework that enables the creation of an administrative user interface which is driven by local and distributed views. Luigi enables the communication between a web application and content-views which the application contains such as routing, navigation, authorization, and user experience elements.

Luigi consists of two components: **Luigi core** and **Luigi client**.

**Luigi core** is installed in the web application while **Luigi client** is installed in the application(s) running in the content-view. Both of these components interact with one another to leverage communication between both the web application and the content-view, without compromising the security principles behind the iframe pattern.

## Installation

To get started with Luigi, read the [Luigi core](https://github.com/kyma-project/luigi/blob/master/core/README.md) document.
### Luigi core

- [Application setup](docs/application-setup.md)
- [Navigation configuration](docs/navigation-configuration.md)
- [Authorization configuration](docs/authorization-configuration.md)
- [Routing mechanism configuration](docs/router-configuration.md)
- [General settings](docs/general-settings.md)
Luigi core is the part of Luigi that enables navigation, security and routing. To get started with Luigi, read [this](docs/application-setup.md) document.

- [Application setup](docs/application-setup.md) - Shows you the first steps to prepare your application for development.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make the full sentences out of those bullet points (with no "-"), such as:
- [Application setup](docs/application-setup.md) shows you the first steps to prepare your application for development.
...

- [Navigation configuration](docs/navigation-configuration.md) - Shows you how to configure navigation.
- [Authorization configuration](docs/authorization-configuration.md) - Shows you how to secure Luigi.
- [Routing mechanism configuration](docs/router-configuration.md) - Demonstrates routing in Luigi.
- [General settings](docs/general-settings.md) - Provides you with configuration parameters.

See [this](https://github.com/kyma-project/luigi/blob/master/client/README.md) document to learn more about the Luigi client.

- [Lifecycle](docs/lifecycle.md)
- [Link Manager](docs/link-manager.md)
- [UX Manager](docs/ux-manager.md)
### Luigi client

Luigi client enables integration of Luigi in views. Configure the lifecycle and links of the client. Customize the appearance of Luigi client.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

of the Luigi client. ???


## Development
- [Lifecycle](docs/lifecycle.md) - Gives you details on the life cycle of listeners, navigation nodes and event data.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make the full sentences out of those bullet points (with no "-")

- [Link Manager](docs/link-manager.md) - Shows how to configure the Link Manager.
- [UX Manager](docs/ux-manager.md) - Shows how to set up the UX Manager.

To run Luigi during your development phase, use the [Angular example application](/core/examples/luigi-sample-angular).
View [example applications](/core/examples).

### Code formatting for contributors

Expand Down
20 changes: 16 additions & 4 deletions docs/application-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

Prior to the implementation of Luigi, you need to set up your application. This document shows you how to set up a web application using the Luigi micro front-end framework.

Choose the framework used to build your application:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd get rid of "used"


[Application setup without a framework](#noframework) <br>
[Angular 6](#angular6)<br>
[SAPUI5/OpenUI5](#sapui5)<br>
[VUE.JS](#vuejs)

## Intitial steps

Follow these steps to build a web application based on Luigi:
Expand All @@ -21,7 +28,8 @@ npm install --save @kyma-project/luigi-client

The examples on this page demonstrate commands that perform each of the necessary steps to set up your application. Each set of commands is grouped by the framework on which you execute it.

### Application setup for an application not using a framework
<a name="noframework"></a>
### Application setup for an application not using a framework

>**NOTE:** You need a development server capable of hosting Single Page Applications. The recommended server is Live Server.

Expand All @@ -45,8 +53,9 @@ $ cp -r node_modules/\@kyma-project/luigi-* public
$ live-server --entry-file=index.html public

````
<a name="angular6"></a>

### Application setup for Angular 6
### Application setup for Angular 6

>**NOTE:** The Angular CLI is a prerequisite for this example.

Expand All @@ -65,8 +74,9 @@ $ sed 's/"src\/assets"/"src\/assets","src\/index.html",{"glob": "**","input": "n
$ ng serve

````
<a name="sapui5"></a>

### Application setup for SAPUI5/OpenUI5
### Application setup for SAPUI5/OpenUI5

>**NOTE:** Live Server must be installed as your development server.

Expand All @@ -91,7 +101,9 @@ $ live-server --entry-file=index.html public

````

### Application setup for VUE.JS
<a name="vuejs"></a>

### Application setup for VUE.JS

>**NOTE:** The VUE CLI is a prerequisite for this example.

Expand Down