Create getting started guide #836

alexandra-simeonova · 2019-09-17T13:27:14Z

Description

Changes proposed in this pull request:

Create getting started guide

Related issue(s)
See also #766

zarkosimic

LGTM! 👍

JohannesDoberer

👍

bszwarc

Added comments :)

docs/getting-started.md

bszwarc · 2019-10-04T08:29:16Z

docs/getting-started.md

+Micro frontends are small frontend web applications that are implemented on one global user interface. They allow you to:
+
+* **break up big, monolithic UIs**: decompose your frontend into smaller chucks and make it more manageable, all while maintaining a consistent user experience.
+* **give individual teams autonomy**: every team in your project can develop their own end-to-end application which exists on the same core app. This gives teams full autonomy over release dates and updates, while also reducing code dependencies.


Suggested change

* **give individual teams autonomy**: every team in your project can develop their own end-to-end application which exists on the same core app. This gives teams full autonomy over release dates and updates, while also reducing code dependencies.

* **give autonomy to individual teams**: every team in your project can develop their own end-to-end implementation based on the same core application. This gives teams full autonomy over release dates and updates, at the same time reducing code dependencies.

I would go with end-to-end implementation more than application - but it might be a preference :D

You're right, because otherwise we repeat "application" twice in the same sentence. 😃

I'm not sure about This gives teams full autonomy over release dates and updates, at the same time reducing code dependencies. There should be a word like "while" somewhere (a subordinating conjunction) because "at the same time reducing code dependencies" isn't a standalone sentence.
Maybe just This gives teams full autonomy over release dates and updates, and at the same time reduces code dependencies.
Or This gives teams full autonomy over release dates and updates, while at the same time reducing code dependencies.?

You are right - I like the second one :) 👍

docs/getting-started.md

bszwarc · 2019-10-04T09:18:28Z

docs/getting-started.md

+
+## Prerequisites 
+
+All you need to get started with Luigi is basic knowledge of HTML and JavaScript. 


Suggested change

All you need to get started with Luigi is basic knowledge of HTML and JavaScript.

All you need to get started with Luigi is the basic knowledge of HTML and JavaScript.

Since "knowledge" is an uncountable noun, I don't think it needs an article 😕

bszwarc · 2019-10-04T09:21:25Z

docs/getting-started.md

+
+### Luigi Core
+
+To create a global user interface and host a full web application in Luigi:


Suggested change

To create a global user interface and host a full web application in Luigi:

Follow these steps to create a global user interface and host a full web application in Luigi:

We usually add an introductory line about the steps to follow :) It doesn't need to be "follow these steps" can be something similar. However, in this case, we have 2 steps - Setting up a Luigi core app + Reading docu. since the introduction says: To create a global user interface and host a full web application in Luigi: I was wondering if we may be more direct in the second step. For example, we can have:
2. Configure the application. To do so, use the Luigi Core documentation. OR
2. Use the Luigi Core documentation to configure your application.

bszwarc · 2019-10-04T10:47:59Z

docs/getting-started.md

+To create a global user interface and host a full web application in Luigi:
+
+1. [Set up a Luigi Core application](https://github.com/SAP/luigi/blob/master/docs/application-setup.md).
+2. [Read the Luigi Core documentation](https://github.com/SAP/luigi/blob/master/docs/README.md#luigi-core).


See comment above ⬆️

bszwarc · 2019-10-04T10:48:36Z

docs/getting-started.md

+
+### Luigi Client
+
+To develop micro frontends and connect them to an already existing Luigi Core app:


Same as above, maybe we can be more specific in the second point :)

Thanks! I made these changes in the latest commit.

Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com>

bszwarc · 2019-10-04T14:31:54Z

docs/getting-started.md

+Micro frontends are small frontend web applications that are implemented on one global user interface. They allow you to:
+
+* **break up big, monolithic UIs**: decompose your frontend into smaller chucks and make it more manageable, all while maintaining a consistent user experience.
+* **give individual teams autonomy**: every team in your project can develop their own end-to-end application which exists on the same core app. This gives teams full autonomy over release dates and updates, while also reducing code dependencies.


You are right - I like the second one :) 👍

bszwarc · 2019-10-04T14:33:58Z

docs/getting-started.md

+
+## Prerequisites 
+
+All you need to get started with Luigi is basic knowledge of HTML and JavaScript. 


Create getting started guide for Luigi

Create getting started guide

915e4b9

alexandra-simeonova requested review from bszwarc, kazydek, mmitoraj and tomekpapiernik as code owners September 17, 2019 13:27

alexandra-simeonova added this to the Sprint 6 milestone Sep 17, 2019

alexandra-simeonova added the documentation documentation tasks label Sep 17, 2019

alexandra-simeonova requested review from hardl, pekura, JohannesDoberer, maxmarkus and marynaKhromova September 17, 2019 14:14

alexandra-simeonova added WIP Work in progress and removed WIP Work in progress labels Sep 18, 2019

zarkosimic self-assigned this Sep 19, 2019

zarkosimic added 2 commits September 19, 2019 19:05

Merge branch 'master' into getting-started-guide

c4a0b3f

Merge branch 'master' into getting-started-guide

f4a6aff

zarkosimic approved these changes Sep 24, 2019

View reviewed changes

alexandra-simeonova mentioned this pull request Sep 30, 2019

Improve Luigi readme #814

Closed

JohannesDoberer approved these changes Oct 1, 2019

View reviewed changes

JohannesDoberer self-assigned this Oct 1, 2019

Merge branch 'master' into getting-started-guide

b447afa

bszwarc suggested changes Oct 4, 2019

View reviewed changes

alexandra-simeonova and others added 6 commits October 4, 2019 13:31

Update docs/getting-started.md

b1bc5f8

Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com>

Update docs/getting-started.md

a3c74e5

Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com>

Update docs/getting-started.md

1601884

Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com>

Update docs/getting-started.md

9f083c4

Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com>

Update docs/getting-started.md

c897b2d

Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com>

improvements based on suggestions

6222586

bszwarc approved these changes Oct 4, 2019

View reviewed changes

alexandra-simeonova added 3 commits October 4, 2019 16:45

improvements based on suggestions

bea33b1

added diagram

ed517d9

added diagram

9869778

alexandra-simeonova requested a review from jesusreal as a code owner October 10, 2019 12:40

JohannesDoberer modified the milestones: Sprint 6, Sprint 7 Oct 14, 2019

Merge branch 'master' into getting-started-guide

a3ae6e4

hardl approved these changes Oct 15, 2019

View reviewed changes

alexandra-simeonova merged commit 5131c65 into SAP:master Oct 15, 2019

alexandra-simeonova deleted the getting-started-guide branch October 15, 2019 13:00

alexandra-simeonova mentioned this pull request Oct 16, 2019

added links to getting started guide #898

Merged

stanleychh pushed a commit to stanleychh/luigi that referenced this pull request Dec 30, 2021

Create getting started guide (SAP#836)

53d384f

Create getting started guide for Luigi

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create getting started guide #836

Create getting started guide #836

alexandra-simeonova commented Sep 17, 2019

zarkosimic left a comment

JohannesDoberer left a comment

bszwarc left a comment

bszwarc Oct 4, 2019

alexandra-simeonova Oct 4, 2019

bszwarc Oct 4, 2019

bszwarc Oct 4, 2019

alexandra-simeonova Oct 4, 2019

bszwarc Oct 4, 2019

bszwarc Oct 4, 2019

bszwarc Oct 4, 2019

bszwarc Oct 4, 2019

alexandra-simeonova Oct 4, 2019

bszwarc Oct 4, 2019

bszwarc Oct 4, 2019

	* give individual teams autonomy: every team in your project can develop their own end-to-end application which exists on the same core app. This gives teams full autonomy over release dates and updates, while also reducing code dependencies.
	* give autonomy to individual teams: every team in your project can develop their own end-to-end implementation based on the same core application. This gives teams full autonomy over release dates and updates, at the same time reducing code dependencies.


		## Prerequisites

		All you need to get started with Luigi is basic knowledge of HTML and JavaScript.


		### Luigi Core

		To create a global user interface and host a full web application in Luigi:

	To create a global user interface and host a full web application in Luigi:
	Follow these steps to create a global user interface and host a full web application in Luigi:


		### Luigi Client

		To develop micro frontends and connect them to an already existing Luigi Core app:

Create getting started guide #836

Create getting started guide #836

Conversation

alexandra-simeonova commented Sep 17, 2019

zarkosimic left a comment

Choose a reason for hiding this comment

JohannesDoberer left a comment

Choose a reason for hiding this comment

bszwarc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment