Move documentation from Wiki to GitHub #122
Conversation
oleg-nenashev
added
the
documentation
| (This refers only to additional messages printed to console, not to a failure stack trace). | ||
| Such output is always kept if the test failed, but by default lengthy output from passing tests is truncated to save space. | ||
| Check this option if you need to see every log message from even passing tests, but beware that Jenkins's memory consumption can substantially increase as a result, even if you never look at the test results! | ||
| * **Health report amplification factor:** The amplification factor to apply to test failures when computing the test result contribution to the build health score. |
There was a problem hiding this comment.
I think this sort of detailed help is best left in help*.html files in the product. Will just go stale here. The online docs should focus on higher-level guidelines and suggestions.
There was a problem hiding this comment.
... but this is just a port of the Wiki page, so fine for now.
There was a problem hiding this comment.
Yeah, did not want to spend much time rewording. Subject for contributions
|
What would happen with the user documentation on plugin wiki? I prefer to have user-docs there... |
|
@olivergondza the first paragraph in the wiki tells users to go to the plugin site instead (I assume the plugin site is easier to scale/customize). So the plugin site is preferred as source for the users. Until now wiki was the only way to edit the content served on the plugin site, but now with https://issues.jenkins-ci.org/browse/WEBSITE-406 released you can use GitHub as the editor as well. |
|
@olivergondza @zbynek Sorry, missed the ping there. Updated POM.xml. |
|
Thanks, was not aware of the WEBSITE-406 effort. |
|
FTR https://groups.google.com/forum/#!topic/jenkinsci-dev/VSdfVMDIW-A . It was just announced 2 days ago, and I forgot to link it in my last comment |
|
Its also probably a good idea to include the format of the junit xml files https://llg.cubic.org/docs/junit/ |
|
@olivergondza would it be possible to merge it so that the improvements get submitted as follow-ups? |
zbynek
moved this from Needs-release
to Merged
in Plugin documentation Migration (Wiki=>GitHub)
zbynek
moved this from Merged
to Released
in Plugin documentation Migration (Wiki=>GitHub)
subj