create content guidelines #877
Merged
+198
−0
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
bszwarc
reviewed
Dec 2, 2019
docs/content-guidelines.md
Outdated
|
|
||
| Documentation on the Luigi website follows the structure below. When adding a new document, you need to place it into one of the five main categories depending on its topic. | ||
|
|
||
| **Basics** |
There was a problem hiding this comment.
I think these can also be subsections (###)
docs/content-guidelines.md
Outdated
|
|
||
| - Only use high resolution images | ||
| - Only use screenshots or diagrams if necessary, as too many of them can create visual noise | ||
| - As an alternative to screenshots, point to the [Luigi fiddle](https://fiddle.luigi-project.io/) or other Luigi examples when you want to illustrate a concept. |
There was a problem hiding this comment.
Suggested change
| - As an alternative to screenshots, point to the [Luigi fiddle](https://fiddle.luigi-project.io/) or other Luigi examples when you want to illustrate a concept. | |
| - As an alternative to screenshots, point to the [Luigi fiddle](https://fiddle.luigi-project.io/) or other Luigi examples when you want to illustrate a concept. |
is it luigi fiddle or the luigi fiddle?
There was a problem hiding this comment.
I changed it to "Luigi Fiddle"
docs/content-guidelines.md
Outdated
|
|
||
| Luigi documentation exists in the form of Markdown files on GitHub, which are then transferred to the main documentation page using Sapper. Find more about what GitHub-flavored Markdown is [here](https://github.github.com/gfm). | ||
|
|
||
| Documentation is located in the `luigi/docs` folder in the [Luigi repository](https://github.com/SAP/luigi). |
There was a problem hiding this comment.
Suggested change
| Documentation is located in the `luigi/docs` folder in the [Luigi repository](https://github.com/SAP/luigi). | |
| Documentation is located in the `luigi/docs` folder in the [Luigi repository](https://github.com/SAP/luigi). |
it can also be documentation resides if you want to keep the active voice. But is located is also good :)
Co-Authored-By: Barbara Szwarc <[email protected]>
bszwarc
approved these changes
Dec 2, 2019
JohannesDoberer
referenced
this pull request
in JohannesDoberer/luigi
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
* create content guidelines Co-authored-by: Zarko Simic <[email protected]> Co-authored-by: Barbara Szwarc <[email protected]>
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:
Related issue(s)
#815