test, docs: Restrict long lines in markdown linter

It's getting out of hand...
This commit is contained in:
James Shubin
2018-02-22 16:19:23 -05:00
parent f01eea33e9
commit 05c60d9a59
6 changed files with 30 additions and 15 deletions

View File

@@ -49,18 +49,26 @@ Please read, enjoy and help improve our documentation!
## Questions: ## Questions:
Please ask in the [community](#community)! Please ask in the [community](#community)!
If you have a well phrased question that might benefit others, consider asking it by sending a patch to the [FAQ](docs/faq.md) section. I'll merge your question, and a patch with the answer! If you have a well phrased question that might benefit others, consider asking
it by sending a patch to the [FAQ](docs/faq.md) section. I'll merge your
question, and a patch with the answer!
## Roadmap: ## Roadmap:
Feel free to grab one of the straightforward [#mgmtlove](https://github.com/purpleidea/mgmt/labels/mgmtlove) issues if you're a first time contributor to the project or if you're unsure about what to hack on! Feel free to grab one of the straightforward [#mgmtlove](https://github.com/purpleidea/mgmt/labels/mgmtlove)
issues if you're a first time contributor to the project or if you're unsure
about what to hack on!
Please see: [TODO.md](TODO.md) for a list of upcoming work and TODO items. Please see: [TODO.md](TODO.md) for a list of upcoming work and TODO items.
Please get involved by working on one of these items or by suggesting something else! Please get involved by working on one of these items or by suggesting something
else!
## Bugs: ## Bugs:
Please set the `DEBUG` constant in [main.go](https://github.com/purpleidea/mgmt/blob/master/main.go) to `true`, and post the logs when you report the [issue](https://github.com/purpleidea/mgmt/issues). Please set the `DEBUG` constant in [main.go](https://github.com/purpleidea/mgmt/blob/master/main.go)
Bonus points if you provide a [shell](https://github.com/purpleidea/mgmt/tree/master/test/shell) or [OMV](https://github.com/purpleidea/mgmt/tree/master/test/omv) reproducible test case. to `true`, and post the logs when you report the [issue](https://github.com/purpleidea/mgmt/issues).
Bonus points if you provide a [shell](https://github.com/purpleidea/mgmt/tree/master/test/shell)
or [OMV](https://github.com/purpleidea/mgmt/tree/master/test/omv) reproducible
test case.
Feel free to read my article on [debugging golang programs](https://purpleidea.com/blog/2016/02/15/debugging-golang-programs/). Feel free to read my article on [debugging golang programs](https://purpleidea.com/blog/2016/02/15/debugging-golang-programs/).
## Patches: ## Patches:

View File

@@ -21,12 +21,13 @@ For more information, you may like to read some blog posts from the author:
* [Send/Recv in mgmt](https://purpleidea.com/blog/2016/12/07/sendrecv-in-mgmt/) * [Send/Recv in mgmt](https://purpleidea.com/blog/2016/12/07/sendrecv-in-mgmt/)
* [Metaparameters in mgmt](https://purpleidea.com/blog/2017/03/01/metaparameters-in-mgmt/) * [Metaparameters in mgmt](https://purpleidea.com/blog/2017/03/01/metaparameters-in-mgmt/)
There is also an [introductory video](https://www.youtube.com/watch?v=LkEtBVLfygE&html5=1) available. There is also an [introductory video](https://www.youtube.com/watch?v=LkEtBVLfygE&html5=1)
Older videos and other material [is available](on-the-web.md). available. Older videos and other material [is available](on-the-web.md).
## Setup ## Setup
You'll probably want to read the [quick start guide](quick-start-guide.md) to get going. You'll probably want to read the [quick start guide](quick-start-guide.md) to
get going.
## Features ## Features
@@ -366,8 +367,8 @@ GOTAGS="noaugeas novirt" make build
## Examples ## Examples
For example configurations, please consult the [examples/](https://github.com/purpleidea/mgmt/tree/master/examples) directory in the git For example configurations, please consult the [examples/](https://github.com/purpleidea/mgmt/tree/master/examples)
source repository. It is available from: directory in the git source repository. It is available from:
[https://github.com/purpleidea/mgmt/tree/master/examples](https://github.com/purpleidea/mgmt/tree/master/examples) [https://github.com/purpleidea/mgmt/tree/master/examples](https://github.com/purpleidea/mgmt/tree/master/examples)

View File

@@ -53,7 +53,8 @@ can be impossible to infer the item's type.
#### map #### map
An unordered set of unique keys of the same type and corresponding value pairs An unordered set of unique keys of the same type and corresponding value pairs
of another type, eg: `{"boiling" => 100, "freezing" => 0, "room" => "25", "house" => 22, "canada" => -30,}`. of another type, eg:
`{"boiling" => 100, "freezing" => 0, "room" => "25", "house" => 22, "canada" => -30,}`.
That is to say, all of the keys must have the same type, and all of the values That is to say, all of the keys must have the same type, and all of the values
must have the same type. You can use any type for either, although it is must have the same type. You can use any type for either, although it is
probably advisable to avoid using very complex types as map keys. probably advisable to avoid using very complex types as map keys.

View File

@@ -31,7 +31,8 @@ Here is a list of the metrics we provide:
- `mgmt_checkapply_total`: The number of CheckApply's that mgmt has run - `mgmt_checkapply_total`: The number of CheckApply's that mgmt has run
- `mgmt_failures_total`: The number of resources that have failed - `mgmt_failures_total`: The number of resources that have failed
- `mgmt_failures`: The number of resources that have failed - `mgmt_failures`: The number of resources that have failed
- `mgmt_graph_start_time_seconds`: Start time of the current graph since unix epoch in seconds - `mgmt_graph_start_time_seconds`: Start time of the current graph since unix
epoch in seconds
For each metric, you will get some extra labels: For each metric, you will get some extra labels:

View File

@@ -3,10 +3,12 @@
# `mgmtconfig-mode` # `mgmtconfig-mode`
[Mgmt](https://github.com/purpleidea/mgmt/) is a distributed, event-driven, parallel configuration management tool. [Mgmt](https://github.com/purpleidea/mgmt/) is a distributed, event-driven,
parallel configuration management tool.
`mgmtconfig-mode` is an Emacs major mode for editing the [mgmt language](https://purpleidea.com/blog/2018/02/05/mgmt-configuration-language/). `mgmtconfig-mode` is an Emacs major mode for editing the [mgmt language](https://purpleidea.com/blog/2018/02/05/mgmt-configuration-language/).
## Installation ## Installation
See the MELPA Emacs Lisp package archives [getting started](https://melpa.org/#/getting-started) guide. Then, select “Options → Manage Emacs Packages” from the menu in Emacs. See the MELPA Emacs Lisp package archives [getting started](https://melpa.org/#/getting-started)
guide. Then, select “Options → Manage Emacs Packages” from the menu in Emacs.

View File

@@ -22,7 +22,6 @@ cat << 'EOF' > $STYLE
all all
exclude_rule 'MD010' # Hard tabs exclude_rule 'MD010' # Hard tabs
exclude_rule 'MD032' # Lists should be surrounded by blank lines exclude_rule 'MD032' # Lists should be surrounded by blank lines
exclude_rule 'MD013' # Line length
exclude_rule 'MD040' # Fenced code blocks should have a language specified exclude_rule 'MD040' # Fenced code blocks should have a language specified
exclude_rule 'MD026' # Trailing punctuation in header exclude_rule 'MD026' # Trailing punctuation in header
exclude_rule 'MD024' # Multiple headers with the same content exclude_rule 'MD024' # Multiple headers with the same content
@@ -35,6 +34,9 @@ exclude_rule 'MD029' # Ordered list item prefix
# FIXME: bug: https://github.com/markdownlint/markdownlint/issues/182 # FIXME: bug: https://github.com/markdownlint/markdownlint/issues/182
exclude_rule 'MD039' # Spaces inside link text exclude_rule 'MD039' # Spaces inside link text
# Line length
rule 'MD013', :line_length => 80, :code_blocks => false, :tables => false
EOF EOF
#STYLE="test/mdl.style" # style file #STYLE="test/mdl.style" # style file