Improve Luigi docs readme file #813
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alexandra-simeonova
requested review from
bszwarc,
kazydek,
mmitoraj and
tomekpapiernik
as code owners
alexandra-simeonova
requested review from
maxmarkus,
hardl,
JohannesDoberer,
pekura and
marynaKhromova
Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com>
Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com>
Changes resulting from a 11.09 meeting with the developers
alexandra-simeonova
added
documentation
maxmarkus
approved these changes
Sep 13, 2019
…luigi into improve-docs-readme
stanleychh
pushed a commit
to stanleychh/luigi
that referenced
this pull request
Dec 30, 2021
* Improve Luigi docs readme file * Update docs/README.md Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com> * Update docs/README.md Co-Authored-By: Barbara Szwarc <barbara.m.szwarc@gmail.com> * Further improvements Changes resulting from a 11.09 meeting with the developers * minor change
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Changes proposed in this pull request:
-Add a link to the Luigi application example
-Add a link to the development guidelines
-Elaborate on the difference between Luigi Core and Luigi Client with 1-2 sentences.
Reason:
I think a lot of people go straight to "docs" when looking for information. It is also linked at the top of the Luigi landing page. It might be useful to include a little more info there.
See also #809