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

Rewrite getting started guide #1766

Merged

Conversation

alexandra-simeonova
Copy link
Contributor

Description

Changes proposed in this pull request:

  • More detailed getting started information
  • Add tutorial and examples

Related issue(s)
Resolves #1743

@UlianaMunich UlianaMunich self-assigned this Dec 10, 2020
@legteodav legteodav self-assigned this Dec 11, 2020
docs/getting-started.md Outdated Show resolved Hide resolved
docs/getting-started.md Outdated Show resolved Hide resolved
docs/getting-started.md Outdated Show resolved Hide resolved
docs/getting-started.md Outdated Show resolved Hide resolved
docs/getting-started.md Outdated Show resolved Hide resolved
Co-authored-by: Uliana Caceres <2720077+UlianaMunich@users.noreply.github.com>
Co-authored-by: legteodav <davide.teodoro.leggieri@sap.com>
Copy link
Contributor

@hardl hardl left a comment

Choose a reason for hiding this comment

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

LGTM

Luigi is an open source JavaScript framework for micro frontends. It enables you to:
* create a unified user interface for a web application using **Luigi Core**.
* create micro frontends and connect them to the Luigi Core app using **Luigi Client**.
Luigi is an open source JavaScript framework for **micro frontends**. Micro frontends can be used to divide big frontend monoliths into smaller, simpler, independent chunks.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Luigi is an open source JavaScript framework for **micro frontends**. Micro frontends can be used to divide big frontend monoliths into smaller, simpler, independent chunks.
Luigi is an open source JavaScript framework for **micro frontends**. Micro frontends that can be used to divide big frontend monoliths into smaller, simpler, independent chunks.

<!-- add-attribute:class:success -->
>**TIP:** Go to our [FAQ section](faq.md) to find more detailed answers to questions like *What are micro frontends?*

The Luigi framework provides configuration options, API functions, and out-of-the-box features which make migrating to a micro frontend architecture easier.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The Luigi framework provides configuration options, API functions, and out-of-the-box features which make migrating to a micro frontend architecture easier.
The Luigi framework provides configuration options, API functions and out-of-the-box features which make migrating to a micro frontend architecture easier.

@alexandra-simeonova alexandra-simeonova merged commit e342d7b into SAP:master Jan 18, 2021
legteodav pushed a commit to legteodav/luigi that referenced this pull request Jan 19, 2021
legteodav added a commit that referenced this pull request Jan 19, 2021
* First commit for wc

* Adding example for WC

* Adding Web Component Documentation

* Doc changes

* Update docs/web-component.md

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Update client-frameworks-support/client-support-angular/projects/client-support-angular/src/lib/route/luigi-activated-route-snapshot-helper.ts

* Update docs/web-component.md

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Fixing error in luigi core doc

* Adding nv documentation

* Update docs/web-component.md

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Update docs/web-component.md

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Update docs/web-component.md

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Update docs/web-component.md

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Update docs/web-component.md

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Update docs/web-component.md

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Update docs/web-component.md

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Update docs/web-component.md

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Update docs/web-component.md

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Update docs/web-component.md

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Update docs/web-component.md

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Update docs/web-component.md

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Update docs/web-component.md

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Update website/fiddle/public/wc/luigiExampleWC.js

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Update website/fiddle/public/wc/luigiExampleWC.js

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Update website/fiddle/public/wc/luigiExampleWC.js

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Update website/fiddle/public/wc/luigiExampleWC.js

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Adding doc images

* Update docs/luigi-core-api.md

Co-authored-by: Uliana Caceres <2720077+UlianaMunich@users.noreply.github.com>

* Removed unused file

* Rename component title

* removed white spaces

* Adding clazz name to fiddle example, removign examples in the documentation

* adding new fiddle component

* Adding UI5 Component

* Changing label UI5 components

* Custom mf for user settings (#1802)

* Rewrite getting started guide (#1766)

* state-store fix (#1814)

Co-authored-by: Stanley Hsu <ching.hsiang.hsu@sap.com>

* ng support lib enhancements (#1809)

Co-authored-by: JohannesDoberer <johannes.doberer@sap.com>

* 1767 different visual appearances (#1790)

* Profile setting dialog (#1710)

* Read/write settings using core api (#1709)

* Dialog box for user settings (#1750)

known issue.. grid is not displayed correctly in ie11

* Adding new configuration for enum displayed as buttons

* Update core/src/UserSettingsEditor.html

Co-authored-by: Stanley Hsu <stanleyhsu1984@gmail.com>

* Changing testdataid with id in html attribute

* Adding again testid

* Update core/src/UserSettingsEditor.html

Co-authored-by: Stanley Hsu <stanleyhsu1984@gmail.com>

* Update core/src/UserSettingsEditor.html

Co-authored-by: Stanley Hsu <stanleyhsu1984@gmail.com>

* Update core/src/UserSettingsEditor.html

Co-authored-by: Stanley Hsu <stanleyhsu1984@gmail.com>

* Update core/src/UserSettingsEditor.html

Co-authored-by: Stanley Hsu <stanleyhsu1984@gmail.com>

* changing button to segment and group....

* Fixing integration tests

Co-authored-by: JohannesDoberer <johannes.doberer@sap.com>
Co-authored-by: Stanley Hsu <stanleyhsu1984@gmail.com>

* merging and resolving conflics

* adding new fiddle component

* Adding UI5 Component

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>
Co-authored-by: Uliana Caceres <2720077+UlianaMunich@users.noreply.github.com>
Co-authored-by: JohannesDoberer <johannes.doberer@sap.com>
Co-authored-by: Aleksandra Simeonova <aleksandra.simeonova@sap.com>
Co-authored-by: Philipp Pracht <philipp.pracht@sap.com>
Co-authored-by: Stanley Hsu <ching.hsiang.hsu@sap.com>
Co-authored-by: Stanley Hsu <stanleyhsu1984@gmail.com>
@alexandra-simeonova alexandra-simeonova deleted the improve-getting-started branch January 20, 2021 08:24
stanleychh pushed a commit to stanleychh/luigi that referenced this pull request Dec 30, 2021
stanleychh added a commit to stanleychh/luigi that referenced this pull request Dec 30, 2021
* First commit for wc

* Adding example for WC

* Adding Web Component Documentation

* Doc changes

* Update docs/web-component.md

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Update client-frameworks-support/client-support-angular/projects/client-support-angular/src/lib/route/luigi-activated-route-snapshot-helper.ts

* Update docs/web-component.md

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Fixing error in luigi core doc

* Adding nv documentation

* Update docs/web-component.md

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Update docs/web-component.md

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Update docs/web-component.md

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Update docs/web-component.md

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Update docs/web-component.md

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Update docs/web-component.md

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Update docs/web-component.md

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Update docs/web-component.md

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Update docs/web-component.md

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Update docs/web-component.md

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Update docs/web-component.md

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Update docs/web-component.md

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Update docs/web-component.md

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Update website/fiddle/public/wc/luigiExampleWC.js

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Update website/fiddle/public/wc/luigiExampleWC.js

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Update website/fiddle/public/wc/luigiExampleWC.js

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Update website/fiddle/public/wc/luigiExampleWC.js

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>

* Adding doc images

* Update docs/luigi-core-api.md

Co-authored-by: Uliana Caceres <2720077+UlianaMunich@users.noreply.github.com>

* Removed unused file

* Rename component title

* removed white spaces

* Adding clazz name to fiddle example, removign examples in the documentation

* adding new fiddle component

* Adding UI5 Component

* Changing label UI5 components

* Custom mf for user settings (SAP#1802)

* Rewrite getting started guide (SAP#1766)

* state-store fix (SAP#1814)

Co-authored-by: Stanley Hsu <ching.hsiang.hsu@sap.com>

* ng support lib enhancements (SAP#1809)

Co-authored-by: JohannesDoberer <johannes.doberer@sap.com>

* 1767 different visual appearances (SAP#1790)

* Profile setting dialog (SAP#1710)

* Read/write settings using core api (SAP#1709)

* Dialog box for user settings (SAP#1750)

known issue.. grid is not displayed correctly in ie11

* Adding new configuration for enum displayed as buttons

* Update core/src/UserSettingsEditor.html

Co-authored-by: Stanley Hsu <stanleyhsu1984@gmail.com>

* Changing testdataid with id in html attribute

* Adding again testid

* Update core/src/UserSettingsEditor.html

Co-authored-by: Stanley Hsu <stanleyhsu1984@gmail.com>

* Update core/src/UserSettingsEditor.html

Co-authored-by: Stanley Hsu <stanleyhsu1984@gmail.com>

* Update core/src/UserSettingsEditor.html

Co-authored-by: Stanley Hsu <stanleyhsu1984@gmail.com>

* Update core/src/UserSettingsEditor.html

Co-authored-by: Stanley Hsu <stanleyhsu1984@gmail.com>

* changing button to segment and group....

* Fixing integration tests

Co-authored-by: JohannesDoberer <johannes.doberer@sap.com>
Co-authored-by: Stanley Hsu <stanleyhsu1984@gmail.com>

* merging and resolving conflics

* adding new fiddle component

* Adding UI5 Component

Co-authored-by: Ndricim Rrapi <ndricim.rrapi@sap.com>
Co-authored-by: Uliana Caceres <2720077+UlianaMunich@users.noreply.github.com>
Co-authored-by: JohannesDoberer <johannes.doberer@sap.com>
Co-authored-by: Aleksandra Simeonova <aleksandra.simeonova@sap.com>
Co-authored-by: Philipp Pracht <philipp.pracht@sap.com>
Co-authored-by: Stanley Hsu <ching.hsiang.hsu@sap.com>
Co-authored-by: Stanley Hsu <stanleyhsu1984@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation documentation tasks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve Getting Started documentation page
4 participants