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

Improve application-setup.md #965

Merged
merged 10 commits into from
Jan 15, 2020

Conversation

alexandra-simeonova
Copy link
Contributor

@alexandra-simeonova alexandra-simeonova commented Nov 13, 2019

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

@alexandra-simeonova alexandra-simeonova added the documentation documentation tasks label Nov 13, 2019
@alexandra-simeonova alexandra-simeonova added this to the Sprint 8 milestone Nov 13, 2019
@maxmarkus maxmarkus changed the title improve application-setup.md Improve application-setup.md Nov 13, 2019
@zarkosimic zarkosimic self-assigned this Nov 19, 2019
Copy link
Contributor

@zarkosimic zarkosimic left a comment

Choose a reason for hiding this comment

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

👍

Copy link
Contributor

@bszwarc bszwarc left a comment

Choose a reason for hiding this comment

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

Added short review

[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.
Copy link
Contributor

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?

Copy link
Contributor Author

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."

Copy link
Contributor

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.

@alexandra-simeonova alexandra-simeonova merged commit 39d957d into SAP:master Jan 15, 2020
JohannesDoberer added a commit to JohannesDoberer/luigi that referenced this pull request Feb 12, 2020
* 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
stanleychh pushed a commit to stanleychh/luigi that referenced this pull request Dec 30, 2021
* improve application-setup.md

Co-authored-by: Barbara Szwarc <barbara.m.szwarc@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.

3 participants