-
Notifications
You must be signed in to change notification settings - Fork 174
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
Improve application-setup.md #965
Improve application-setup.md #965
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added short review
docs/application-setup.md
Outdated
[VUE.JS](#vuejs) | ||
|
||
## Basic application setup | ||
All those steps are condensed in a single installer script which sets up a Luigi application on your system. Keep in mind that if you have a single page application, you need to transfer it to a two-page application. Your application should run to make sure the existing router doesn't interfere. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The last sentence is a bit confusing to me: does it mean that the application needs to be running to check if there is no interference with the router or that you should run it to see if there is no such interference?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's the second one :) I changed it to "You should run your application to make sure the existing router doesn't interfere."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Then I would put it this way - it's more direct and clear.
f8b6d10
to
64fcf51
Compare
423f2d6
to
e44f8c9
Compare
Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com>
e44f8c9
to
8cf8363
Compare
* master: Debug cypress travis issue (SAP#1097) Fix communication from external mf using customMessages (SAP#1081) fix fd-modal mix-up (SAP#1068) who is using luigi in about page (SAP#1077) Add cobrick logo (SAP#1072) who is using luigi button (SAP#1066) Update README.md Update README.md release v0.7.4 (SAP#1069) fix items calculation in more btn of tab nav(SAP#1065) Add valid href to navigation links (SAP#1034) fix runtime error when contextSwitcher is not defined (SAP#1047) Improve API documentation (SAP#1025) Improve authorization doc structure (SAP#1024) Improve Overview page (SAP#1000) Improve application-setup.md (SAP#965) create content guidelines (#877) Documentation fixes (SAP#1003) # Conflicts: # docs/luigi-core-api.md # test/e2e.sh
* improve application-setup.md Co-authored-by: Barbara Szwarc <barbara.m.szwarc@gmail.com>
Improve the application setup document with better formatting. Before, it was not clear whether the "Basic setup" steps actually had to be performed by the user. The goal is to make the meaning of this section clearer.
See: #955