-
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 basic configuration and documentation #135
Improve basic configuration and documentation #135
Conversation
<h1 class="fd-action-bar__title"> | ||
Basic Example page | ||
</h1> | ||
<p class="fd-action-bar__description">This page behaves equally to an external hosted micro front-end.</p> |
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.
I do not get what is the intent of saying this. Maybe it would be interesting to say that this example behaves like a single page app.
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.
How about: This micro front-end behaves like a single page application.
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.
That is better I think.
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.
Two minor comments.
@@ -30,13 +30,22 @@ To have this application running, follow these steps: | |||
``` | |||
|
|||
4. Start the example application from the `luigi/core/examples/luigi-sample-angular` folder. | |||
|
|||
`/assets/sampleConfiguration.js` is the default configuration with a showcase of all available features. If you want to try out the much simpler example, change the configuration reference in `index.html` to `basicConfiguration.js`. |
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.
try out the much simpler > try out a much simpler
npm run start | ||
``` | ||
|
||
To run Luigi with path based routing, change the **routing.useHashrouting** configuration to `false` and run the following command: |
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.
Maybe we can have it as an unordered list:
- To run Luigi with hash based routing ...
- To run Luigi with path based routing ...
It would make the instructions clearer.
…us/luigi into improve-basic-configuration-docu
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.
Approved.
…asic-configuration-docu
* improved documentation and basic configuration
Resolves
#134