Create getting started guide #836
Conversation
alexandra-simeonova
requested review from
bszwarc,
kazydek,
mmitoraj and
tomekpapiernik
as code owners
alexandra-simeonova
requested review from
hardl,
pekura,
JohannesDoberer,
maxmarkus and
marynaKhromova
docs/getting-started.md
Outdated
| 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. |
There was a problem hiding this comment.
| * **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
There was a problem hiding this comment.
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.?
There was a problem hiding this comment.
You are right - I like the second one :) 👍
docs/getting-started.md
Outdated
|
|
||
| ## Prerequisites | ||
|
|
||
| All you need to get started with Luigi is basic knowledge of HTML and JavaScript. |
There was a problem hiding this comment.
| 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. |
There was a problem hiding this comment.
Since "knowledge" is an uncountable noun, I don't think it needs an article 😕
docs/getting-started.md
Outdated
|
|
||
| ### Luigi Core | ||
|
|
||
| To create a global user interface and host a full web application in Luigi: |
There was a problem hiding this comment.
| 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.
docs/getting-started.md
Outdated
| 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). |
docs/getting-started.md
Outdated
|
|
||
| ### Luigi Client | ||
|
|
||
| To develop micro frontends and connect them to an already existing Luigi Core app: |
There was a problem hiding this comment.
Same as above, maybe we can be more specific in the second point :)
There was a problem hiding this comment.
Thanks! I made these changes in the latest commit.
Co-Authored-By: Barbara Szwarc <[email protected]>
Co-Authored-By: Barbara Szwarc <[email protected]>
Co-Authored-By: Barbara Szwarc <[email protected]>
Co-Authored-By: Barbara Szwarc <[email protected]>
Co-Authored-By: Barbara Szwarc <[email protected]>
docs/getting-started.md
Outdated
| 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. |
There was a problem hiding this comment.
You are right - I like the second one :) 👍
docs/getting-started.md
Outdated
|
|
||
| ## Prerequisites | ||
|
|
||
| All you need to get started with Luigi is basic knowledge of HTML and JavaScript. |
Create getting started guide for Luigi
Description
Changes proposed in this pull request:
Related issue(s)
See also #766