Update README.md to include list of rules #82
Conversation
jbouter
commented
Oct 25, 2019
jbouter
commented
- Add a table with all rules, linking to corresponding wiki entries
- Add a table with all rules, linking to corresponding wiki entries Signed-off-by: Jeffrey Bouter <jb@warpnet.nl>
| | [210](https://github.com/warpnet/salt-lint/wiki/210) | Numbers that start with `0` should always be encapsulated in quotation marks | | ||
| | [211](https://github.com/warpnet/salt-lint/wiki/211) | `pillar.get` or `grains.get` should be formatted differently | | ||
| | [212](https://github.com/warpnet/salt-lint/wiki/212) | Most files should not contain irregular spaces | | ||
|
|
There was a problem hiding this comment.
Also, I believe issue #70 was about having more detailed explanations (the why). So all of the content here will probably have to be expanded.
There was a problem hiding this comment.
OK, this part is a non-issue, since the links lead to the wiki. It's funny, I didn't see the link immediately when looking at this from View file. Perhaps I wouldn't have missed it as easily if the main statement was the link? More noticeable, perhaps.
There was a problem hiding this comment.
So perhaps the rule numbers in bold and the main text as the links? Just some thoughts for you to consider, feel free to ignore this suggestion.
There was a problem hiding this comment.
@jbouter Sure, keep it that way. I just didn't see the link at first, that's all! But I'm sure it will be fine.
The one thing that probably needs adjusting is whether to use leading and trailing bars (|) or not. So the line that has been modified should follow the same system as the rest of the table.
Thanks for providing this feature, by the way.
There was a problem hiding this comment.
Hey @myii, thanks for your review. I've modified the table to be simpler to edit as per your suggestion. Could you review it once more?
There was a problem hiding this comment.
@jbouter Sure, it looks nice and tidy, thanks!
Update rules list in `README.md` to simply the markdown table. Co-Authored-By: Imran Iqbal <myii@users.noreply.github.com>
- Simplify the markdown table as per @myii his recommendations Signed-off-by: Jeffrey Bouter <jb@warpnet.nl>
