docs: add daemon config file doc #1257
Conversation
|
markdown lint files, please write the document in markdownlint tool's rules. @Ace-Tang |
docs/user/config_file.md
Outdated
| ## Note | ||
|
|
||
| 1. The same flag(exclude slice or array type) can not be set through command | ||
| line and config file 同时. |
There was a problem hiding this comment.
please remove the 同时 here. :)
docs/user/config_file.md
Outdated
| * The same flag(exclude slice or array type) can not be set through command | ||
| line and config file simultaneously. | ||
| * We allow users set slice or array type of flag simultaneously from command | ||
| and config file line，and merge them. |
There was a problem hiding this comment.
#!/bin/bash -eo pipefail
find ./ -name "*.md" | grep -v vendor | grep -v extra | grep -v commandline | grep -v .github | grep -v swagger | grep -v api | xargs mdl -r ~MD013,~MD024,~MD029,~MD033,~MD036
./docs/user/config_file.md:26: MD032 Lists should be surrounded by blank lines
./docs/user/config_file.md:28: MD032 Lists should be surrounded by blank lines
Exited with code 123
I do not see why this is wrong
|
|
||
| ### Note | ||
|
|
||
| * The same flag(exclude slice or array type) can not be set through command |
There was a problem hiding this comment.
maybe need a blank line here
There was a problem hiding this comment.
no, if add a blank line here, it will cause another error, which means just allow one blank line
There was a problem hiding this comment.
The rules confuse me very much !!!
There was a problem hiding this comment.
Hi @Ace-Tang , the rule is here. https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md032---lists-should-be-surrounded-by-blank-lines
I think you can add the indent in the newline. Please have a try. haha
There was a problem hiding this comment.
As the text say
Some text
* Some
* List
I must add a text before *some, but if I do not want to add text, I just want * some follow ## title, how do I need to do.
Signed-off-by: Ace-Tang <[email protected]>
Codecov Report
@@ Coverage Diff @@
## master #1257 +/- ##
==========================================
- Coverage 15.59% 15.31% -0.29%
==========================================
Files 173 172 -1
Lines 10819 10665 -154
==========================================
- Hits 1687 1633 -54
+ Misses 9013 8912 -101
- Partials 119 120 +1
|
|
Still wondering where to locate this document file. If we add a new folder user, I think we should update the docs/README.md . |
|
I do not think it proper to put the file under docs/commandline. @allencloud ， docs/commandline should include command line related info. |
|
I will merge this pr first, if has any problem, feel free to contact me thanks, @Ace-Tang @allencloud @fuweid |
Signed-off-by: Ace-Tang [email protected]
Ⅰ. Describe what this PR did
Ⅱ. Does this pull request fix one issue?
Ⅲ. Describe how you did it
Ⅳ. Describe how to verify it
Ⅴ. Special notes for reviews