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.

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

categories for documentation #907

Merged
merged 42 commits into from
Nov 5, 2019
Merged
Show file tree
Hide file tree
Changes from 27 commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
28923c7
update readme file with categories
alexandra-simeonova Oct 21, 2019
224329e
update docs/README.md
alexandra-simeonova Oct 22, 2019
ff1638f
update README.md
alexandra-simeonova Oct 23, 2019
ae52248
create navigation-advanced.md
alexandra-simeonova Oct 24, 2019
eb62e39
update
alexandra-simeonova Oct 25, 2019
b35855c
image resize
alexandra-simeonova Oct 25, 2019
9e0c121
update README.md
alexandra-simeonova Oct 25, 2019
7bfe26a
update README.md
alexandra-simeonova Oct 25, 2019
12fa0f6
update navigation-advanced.md
alexandra-simeonova Oct 29, 2019
28c424c
update readme file with categories
alexandra-simeonova Oct 21, 2019
64ff000
update docs/README.md
alexandra-simeonova Oct 22, 2019
2daea36
update README.md
alexandra-simeonova Oct 23, 2019
36d80f0
create navigation-advanced.md
alexandra-simeonova Oct 24, 2019
8d17e71
update
alexandra-simeonova Oct 25, 2019
7d98153
image resize
alexandra-simeonova Oct 25, 2019
7e0a747
update README.md
alexandra-simeonova Oct 25, 2019
b86025d
update README.md
alexandra-simeonova Oct 25, 2019
8d363fb
update navigation-advanced.md
alexandra-simeonova Oct 29, 2019
c70658f
Merge branch 'documentation-categories' of https://github.com/alexand…
alexandra-simeonova Oct 30, 2019
070d00d
fixing links
alexandra-simeonova Oct 31, 2019
238ee67
fixing links
alexandra-simeonova Oct 31, 2019
19df95d
typo fix
alexandra-simeonova Oct 31, 2019
3a732ad
update navigation-advanced.md
alexandra-simeonova Oct 31, 2019
4ac198e
Merge branch 'master' into documentation-categories
alexandra-simeonova Oct 31, 2019
10878a5
update navigation-advanced.md
alexandra-simeonova Oct 31, 2019
514f12d
Merge branch 'documentation-categories' of github.com:alexandra-simeo…
alexandra-simeonova Oct 31, 2019
9bf3c82
add link to configuration flag
alexandra-simeonova Nov 4, 2019
7ca7e55
Update docs/README.md
alexandra-simeonova Nov 4, 2019
e1454f6
Update docs/README.md
alexandra-simeonova Nov 4, 2019
3408b22
Update docs/navigation-advanced.md
alexandra-simeonova Nov 4, 2019
30c8f03
Update docs/navigation-configuration.md
alexandra-simeonova Nov 4, 2019
b4c7738
Update docs/README.md
alexandra-simeonova Nov 4, 2019
62ce0e0
Update docs/README.md
alexandra-simeonova Nov 4, 2019
9380481
Update docs/README.md
alexandra-simeonova Nov 4, 2019
809bd9d
Update docs/navigation-advanced.md
alexandra-simeonova Nov 4, 2019
8997f84
Update docs/navigation-advanced.md
alexandra-simeonova Nov 4, 2019
a19cbcc
Update docs/navigation-advanced.md
alexandra-simeonova Nov 4, 2019
d956056
Update docs/navigation-advanced.md
alexandra-simeonova Nov 4, 2019
4c149c7
Update docs/navigation-advanced.md
alexandra-simeonova Nov 4, 2019
09246fb
changes based on suggestions
alexandra-simeonova Nov 4, 2019
9848b15
Merge branch 'documentation-categories' of github.com:alexandra-simeo…
alexandra-simeonova Nov 4, 2019
10f13e6
Merge branch 'master' into documentation-categories
alexandra-simeonova Nov 5, 2019
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
59 changes: 36 additions & 23 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,51 @@
# Luigi Documentation
# Luigi Documentation

The aim of this documentation is to provide step-by-step instructions for Luigi as well as to provide a comprehensive reference of all the features you can use.
If you are new to Luigi, read the [Getting started guide](getting-started.md) to learn more about its structure and key functions.

If you are new to Luigi, go to the [Getting started guide](getting-started.md) to learn more about its structure and key functions.
## Luigi Core

## Luigi Core
Luigi Core enables you to create a web application with an easily configurable and consistent user interface.

Set up and configure your main Luigi application by following these guides. The Luigi Core libraries allow you to create a user interface where you can configure navigation, authorization, and more.
[Installation](application-setup.md) shows you the first steps to prepare your application for development.

* [Application setup](application-setup.md) shows you the first steps to prepare your application for development.
* [Navigation configuration](navigation-configuration.md) shows you how to configure navigation in Luigi.
* [Navigation parameters reference](navigation-parameters-reference.md) lists the parameters you can use to configure the top and side navigation.
* [Authorization configuration](authorization-configuration.md) guides you through the configuration to secure Luigi.
* [Authorization events](authorization-events.md) guides you through the event configuration to react to Luigi authorization events.
* [General settings](general-settings.md) provides you with additional configuration parameters for Luigi.
* [Luigi lifecycle hooks](lifecycle-hooks.md) allows you to execute custom logic on any of the Luigi lifecycle steps.
* [Core API](luigi-core-api.md) provides you with API features that help you enrich and use Luigi Core.
* [Luigi UI features](luigi-ux-features.md) provides different customization options for some of the Luigi UI components.
### Configuration

## Luigi Client
> **TIP:** The [Luigi Fiddle](https://fiddle.luigi-project.io) allows you to configure a very simple application and get a feel for the process.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is it the Luigi Fiddle or just Luigi Fiddle - both may be correct, so just asking :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Normally it's Luigi Fiddle or the Luigi Fiddle page/website, so you're right 😄


Luigi Client enables you to connect micro frontends or views to the main Luigi Core application. Find the Luigi Client API documentation here and learn more about the functions and parameters used to define lifecycles, links, and the appearance of the application.
To configure your Luigi application, simply edit the files in the `luigi-config` folder of your project. Luigi configuration is divided into several sections, which are outlined in the guides below:

* [Lifecycle](luigi-client-api.md#lifecycle) gives you details on the lifecycle of listeners, navigation nodes, and Event data.
* [Link Manager](luigi-client-api.md#linkmanager) allows you to navigate to a specific route.
* [UX Manager](luigi-client-api.md#uxmanager) helps you manage the appearance features in Luigi, such as the behaviour of backdrop or loading indicators.
* [Navigation (basic)](navigation-configuration.md) - configure basic top and side navigation, links, and categories.
* [Navigation (advanced)](navigation-advanced.md) - create a dynamic path, reuse micro frontends with the same origin, and configure additional navigation elements. 
* [Routing](navigation-parameters-reference.md#routing) - define routing options for your application.
* [Authorization](authorization-configuration.md) - configure login and security features for your application.
* [Authorization events](authorization-events.md) - event configuration used to react to Luigi authorization events.
* [General settings](general-settings.md) - fully customize a micro frontend, define a header, make your application responsive, and more.
* [Lifecycle hooks](lifecycle-hooks.md) - execute custom logic on any of the Luigi lifecycle steps.

## Core/Client communication
* [Communication](communication.md) describes how to configure features related to communication between Luigi Core and Client.
The following guides outline Luigi Core API features and additional UI options that exist outside the configuration files:

* [Core API](luigi-core-api.md) - API features that help you enrich and use Luigi Core.
* [Luigi UI features](luigi-ux-features.md) - customization options for some of the Luigi UI components.

## Luigi Client

Luigi Client enables you to connect micro frontends to an already existing Luigi Core application.

[Installation](https://github.com/SAP/luigi/tree/master/client) shows you how to install the Luigi Client.

Read the Luigi Client API documentation to learn more about the functions and parameters you can use to communicate with the core application:

* [Lifecycle](luigi-client-api.md#lifecycle) - details on the lifecycle of listeners, navigation nodes, and Event data.
* [Link Manager](luigi-client-api.md#linkmanager) - navigate to a specific route.
* [UX Manager](luigi-client-api.md#uxmanager) - manage appearance options such as the behavior of backdrop or loading indicators.

## Advanced
* [Communication](communication.md) describes how to send custom messages between Luigi Core and Client.

## Examples

Follow the Luigi [application examples](../core/examples/README.md) for an in-depth look at Luigi capabilities.
Follow the Luigi [application examples](../core/examples/README.md) for an in-depth look at Luigi capabilities.

## Development

Read the [development and code formatting guidelines](https://github.com/SAP/luigi#development) if you are interested in contributing.
Read the [development and code formatting guidelines](https://github.com/SAP/luigi#development) if you are interested in contributing.
Binary file added docs/assets/app-switcher.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/context-switcher.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/product-switcher.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/profile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading