lourenco/mgmt
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

readme, docs: New docs available

Browse Source
This commit is contained in:
James Shubin
2024-11-23 01:25:40 -05:00
parent 28a443d11d
commit 380004b1dc
3 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -10,6 +10,12 @@
[![Patreon](https://img.shields.io/badge/patreon-donate-yellow.svg?style=flat-square)](https://www.patreon.com/purpleidea)
[![Liberapay](https://img.shields.io/badge/liberapay-donate-yellow.svg?style=flat-square)](https://liberapay.com/purpleidea/donate)
> [!TIP]
> [Resource reference guide now available!](https://mgmtconfig.com/docs/resources/)
> [!TIP]
> [Function reference guide now available!](https://mgmtconfig.com/docs/functions/)
## About:
`Mgmt` is a real-time automation tool. It is familiar to existing configuration
@@ -92,6 +98,8 @@ Please read, enjoy and help improve our documentation!
| [quick start guide](docs/quick-start-guide.md) | for everyone |
| [frequently asked questions](docs/faq.md) | for everyone |
| [general documentation](docs/documentation.md) | for everyone |
| [resource reference](https://mgmtconfig.com/docs/resources/) | for everyone |
| [function reference](https://mgmtconfig.com/docs/functions/) | for everyone |
| [language guide](docs/language-guide.md) | for everyone |
| [function guide](docs/function-guide.md) | for mgmt developers |
| [resource guide](docs/resource-guide.md) | for mgmt developers |

1
docs/on-the-web.md
View File

@@ -59,3 +59,4 @@ if we missed something that you think is relevant!
| James Shubin | video | [Recording from CfgMgmtCamp.eu 2023](https://www.youtube.com/watch?v=FeRGRj8w0BU) |
| James Shubin | video | [Recording from FOSDEM 2024, Golang Devroom](https://video.fosdem.org/2024/ud2218a/fosdem-2024-2575-single-binary-full-stack-provisioning.mp4) |
| James Shubin | video | [Recording from CfgMgmtCamp.eu 2024](https://www.youtube.com/watch?v=vBt9lpGD4bc) |
| James Shubin | blog | [Mgmt Configuration Language: Functions](https://purpleidea.com/blog/2024/11/22/functions-in-mgmt/) |

1
test/test-markdownlint.sh
View File

@@ -21,6 +21,7 @@ STYLE=$($mktemp)
cat << 'EOF' > "$STYLE"
all
exclude_rule 'MD010' # Hard tabs
exclude_rule 'MD028' # Blank line inside blockquote
exclude_rule 'MD032' # Lists should be surrounded by blank lines
exclude_rule 'MD034' # Bare URL used
exclude_rule 'MD040' # Fenced code blocks should have a language specified