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 navigation-configuration.md #826

Merged

Conversation

alexandra-simeonova
Copy link
Contributor

Description

Improve the Luigi /docs "navigation configuration" file

Changes proposed in this pull request:

  • TOC added
  • new structure of the doc
  • added simpler examples
  • "parameters" was used in two contexts having two different meanings before, which was confusing. I suggest using two different terms: "parameters" and "variables"

Related issue(s)
See also: #766

docs/navigation-configuration.md Outdated Show resolved Hide resolved
docs/navigation-configuration.md Outdated Show resolved Hide resolved
docs/navigation-configuration.md Outdated Show resolved Hide resolved
docs/navigation-configuration.md Outdated Show resolved Hide resolved
docs/navigation-configuration.md Outdated Show resolved Hide resolved
docs/navigation-configuration.md Outdated Show resolved Hide resolved
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.

I added some comments :)

docs/navigation-configuration.md Outdated Show resolved Hide resolved
docs/navigation-configuration.md Outdated Show resolved Hide resolved
docs/navigation-configuration.md Outdated Show resolved Hide resolved
docs/navigation-configuration.md Outdated Show resolved Hide resolved
docs/navigation-configuration.md Outdated Show resolved Hide resolved
docs/navigation-configuration.md Outdated Show resolved Hide resolved
docs/navigation-configuration.md Outdated Show resolved Hide resolved
docs/navigation-configuration.md Outdated Show resolved Hide resolved
docs/navigation-configuration.md Show resolved Hide resolved
docs/navigation-configuration.md Outdated Show resolved Hide resolved
Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com>
Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com>
Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com>
Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com>
Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com>
Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com>
Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com>
Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com>
Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com>
@zarkosimic zarkosimic self-assigned this Sep 23, 2019
Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com>
Change based on Zarko's comments
Changed back to parameters based on Philipp's advice
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.

LGTM! 👍

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 some minor comments and resolved the other ones (from the previous review)

docs/navigation-configuration.md Outdated Show resolved Hide resolved
docs/navigation-configuration.md Show resolved Hide resolved
docs/navigation-configuration.md Show resolved Hide resolved
docs/navigation-configuration.md Show resolved Hide resolved
docs/navigation-configuration.md Outdated Show resolved Hide resolved
docs/navigation-configuration.md Outdated Show resolved Hide resolved
docs/navigation-configuration.md Show resolved Hide resolved
docs/navigation-configuration.md Show resolved Hide resolved
docs/navigation-configuration.md Show resolved Hide resolved
docs/navigation-configuration.md Show resolved Hide resolved
Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com>
Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com>
Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com>
@alexandra-simeonova alexandra-simeonova merged commit 9c7ccd9 into SAP:master Sep 30, 2019
@alexandra-simeonova alexandra-simeonova deleted the improve-navigationconfig-doc branch September 30, 2019 11:05
alexandra-simeonova added a commit that referenced this pull request Sep 30, 2019
stanleychh pushed a commit to stanleychh/luigi that referenced this pull request Dec 30, 2021
* Improve navigation-configuration.md

* Improvements based on suggestions

* Update docs/navigation-configuration.md

Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com>

* Update docs/navigation-configuration.md

Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com>

* Update docs/navigation-configuration.md

Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com>

* Update docs/navigation-configuration.md

Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com>

* Update docs/navigation-configuration.md

Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com>

* Update docs/navigation-configuration.md

Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com>

* Update docs/navigation-configuration.md

Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com>

* Update docs/navigation-configuration.md

Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com>

* Update docs/navigation-configuration.md

Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com>

* Update docs/navigation-configuration.md

Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com>

* Changes based on suggestions

* small change

* Changes based on suggestions

Change based on Zarko's comments

* Changed 'variables' to parameters

Changed back to parameters based on Philipp's advice

* Update docs/navigation-configuration.md

* Update docs/navigation-configuration.md

Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com>

* Update docs/navigation-configuration.md

Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com>

* Update docs/navigation-configuration.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.

4 participants