docs(configuration): Improve docs for curations in .ort.yml
#7754
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #7754 +/- ##
=========================================
Coverage 67.65% 67.65%
Complexity 2044 2044
=========================================
Files 354 354
Lines 16870 16870
Branches 2387 2387
=========================================
Hits 11414 11414
Misses 4465 4465
Partials 991 991
Flags with carried forward coverage won't be shown. Click here to find out more.
☔ View full report in Codecov by Sentry. |
| @@ -85,7 +85,7 @@ The path exclude above has the following effects: | |||
|
|
|||
| * All projects found below the `test-data` directory are marked as excluded. | |||
| * License findings in files below the `test-data` directory are marked as excluded. This can be used in | |||
| [evaluator rules](../../tutorial/intro#6-running-the-evaluator) to for instance change the severity from error to | |||
| [evaluator rules](../../tutorial/intro.md#6-running-the-evaluator) to for instance change the severity from error to | |||
There was a problem hiding this comment.
The link on the website works just fine if you test it here: https://oss-review-toolkit.org/ort/docs/configuration/ort-yml#excluding-paths
Because the tutorial is a separate instance of the docs plugin currently URL links have to be used, see the warning at the bottom of this page or this comment.
There was a problem hiding this comment.
I just thought that we could merge the tutorial into the docs to avoid this issue by having only one instance of the docs plugin, what do you think?
There was a problem hiding this comment.
only one instance of the docs plugin
Sorry, which docs plugin?
Anyway, you're the expert here, so whatever you say 😆 I was only addressing this as the markdown-links check failed.
There was a problem hiding this comment.
Sorry, which docs plugin?
The docs plugin for docusaurus, we currently use two instances of the plugin, one for the docs and one for the tutorial. So links between those two must be URL links.
Anyway, you're the expert here, so whatever you say 😆 I was only addressing this as the markdown-links check failed.
I will try to find the time to make that change in a separate PR, but until then the second commit should be removed as to my understanding it would actually break the link on the website. I wonder why the markdown lint check was failing, if this link is an issue it should also have failed before?
There was a problem hiding this comment.
we currently use two instances of the plugin, one for the docs and one for the tutorial.
That sounds weird... and I wasn't aware of that. Thanks for pointing that out.
I wonder why the markdown lint check was failing, if this link is an issue it should also have failed before?
Correct. Apparently some caching takes place until the particular file is touched in a PR...
There was a problem hiding this comment.
I think the ignore pattern in the mlc_config.json needs to be changed to "^../../tutorial/intro.*$" to silence the markdown link check issue.
There was a problem hiding this comment.
I gave it a try (with a slightly more specific pattern).
sschuberth
force-pushed
the
improve-ort-yml-curation-docs
branch
from
fbd2691
to
d9243d0
Compare
|
I ended up rewriting / reordering larger parts than planned as I found the docs to be more and more lacking the more often I read it. |
sschuberth
force-pushed
the
improve-ort-yml-curation-docs
branch
from
d9243d0
to
ba8ce72
Compare
Improve the documentation to better explain why both `curations` and `packageConfigurations` have nested `LicenseFindingCuration`s: Their scopes are different (project vs. package). Signed-off-by: Sebastian Schuberth <sschuberth@gmail.com>
Clearly separate curations from package configurations, like it is done for global ORT configuration, for a better overview. Signed-off-by: Sebastian Schuberth <sschuberth@gmail.com>
sschuberth
force-pushed
the
improve-ort-yml-curation-docs
branch
from
ba8ce72
to
cdf77cd
Compare
Signed-off-by: Sebastian Schuberth <sschuberth@gmail.com>
sschuberth
force-pushed
the
improve-ort-yml-curation-docs
branch
from
92ad92c
to
24de18a
Compare
No description provided.