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

categories for documentation #907

Merged
merged 42 commits into from
Nov 5, 2019

Conversation

alexandra-simeonova
Copy link
Contributor

Description

Changes proposed in this pull request:

  • Split Luigi documentation into smaller categories
  • Create a documentation structure which will be reflected on the Luigi website
  • Add explanations and examples where needed

Related issue(s)
#766, #906

@alexandra-simeonova alexandra-simeonova changed the title update readme file with categories categories for documentation Oct 21, 2019
@alexandra-simeonova alexandra-simeonova added the documentation documentation tasks label Oct 21, 2019
@alexandra-simeonova alexandra-simeonova added this to the Sprint 7 milestone Oct 21, 2019
@maxmarkus maxmarkus self-assigned this Oct 28, 2019
Copy link
Contributor

@maxmarkus maxmarkus left a comment

Choose a reason for hiding this comment

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

Good work! Just two small comments


The view groups feature also offers out-of-the-box caching. Each time you navigate to another view group, either a new iframe is created or it is reused if already exists. In both cases, the iframe you are navigating from becomes hidden and is available for you to use again. If you navigate back to the first iframe and it should be updated with new data, such when a new entry was added in the second iframe and you want to display it in a table in the first iframe, you must define a **preloadUrl** parameter for the view group under **navigation.viewGroupSettings**.

You can also preload view groups. You just need to define which URL you want to preload, and Luigi will preload the view after some user interactions when the browser is most likely to be idle. This option is active by default, but you can deactivate it with a [configuration flag](navigation-parameters-reference.md#node-parameters).
Copy link
Contributor

Choose a reason for hiding this comment

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

We should show name the configuration flag here, else the user has no clue which configuration flag we are talking about. I also am not 100% sure, maybe it is preloadViewUrl (bool) in /navigation-parameters-reference.md#node-navigation-parameters?

Copy link
Contributor Author

@alexandra-simeonova alexandra-simeonova Oct 29, 2019

Choose a reason for hiding this comment

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

Thank you for the comment! I think the configuration flag for this is preloadViewGroup, so I changed the doc.

docs/navigation-configuration.md Outdated Show resolved Hide resolved
@marynaKhromova marynaKhromova self-assigned this Oct 28, 2019
Copy link
Contributor

@marynaKhromova marynaKhromova left a comment

Choose a reason for hiding this comment

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

Hi Alex. A lot of work has been done here. Good job :)

Please check my comments below.

docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/navigation-advanced.md Outdated Show resolved Hide resolved
docs/navigation-advanced.md Outdated Show resolved Hide resolved
docs/navigation-advanced.md Outdated Show resolved Hide resolved
docs/navigation-advanced.md Show resolved Hide resolved
docs/navigation-configuration.md Outdated Show resolved Hide resolved
@JohannesDoberer JohannesDoberer self-assigned this Nov 4, 2019
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 comments :)

docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated

## Luigi Client
> **TIP:** The [Luigi Fiddle](https://fiddle.luigi-project.io) allows you to configure a very simple application and get a feel for the process.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is it the Luigi Fiddle or just Luigi Fiddle - both may be correct, so just asking :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Normally it's Luigi Fiddle or the Luigi Fiddle page/website, so you're right 😄

docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/navigation-advanced.md Outdated Show resolved Hide resolved
This document shows you how to configure the following Luigi features:

* [View groups](#view-groups)
* [Create a dynamically changeable path](#create-a-dynamic-path)
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm wondering if we can switch it to just Dynamic paths - to make the points match.

docs/navigation-configuration.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
Comment on lines 21 to 22
1. Define the **viewGroup** parameter for any navigation node.
2. Children of that node will automatically be considered part of the same view group.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think these two do not go well with the introductory line - the first one starting with define is fine :) but the second one is not a step. I think maybe it's better to have it in one sentence?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Agreed! 🙂

@pekura pekura merged commit b2fb0d9 into SAP:master Nov 5, 2019
@alexandra-simeonova alexandra-simeonova deleted the documentation-categories branch November 6, 2019 09:06
@alexandra-simeonova alexandra-simeonova mentioned this pull request Nov 6, 2019
stanleychh pushed a commit to stanleychh/luigi that referenced this pull request Dec 30, 2021
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.

6 participants