How it works
There is no form or pull request process. Email your contribution to info@rconfig.com and we take it from there:
- You email it in with the details listed below.
- We review and test it. We may come back to you with questions.
- We write it up and publish it on your behalf, edited to match the style and structure of the rest of the site.
- We credit you and post your sticker pack.
Sending something in does not guarantee it will be published. Everything is subject to review.
What we accept
- Policy rules: a compliance definition that checks something useful, ideally one that caught a real problem.
- Platform support: commands, prompts and connection settings for a device type or OS we don't cover yet.
- Architectures: how you've laid out rConfig or Vector for a real environment, with the trade-offs you weighed (sites, collectors, network zones, scale).
- Best practices: approaches that have worked for you, such as scheduling, tagging, backup retention, access control or change review.
- Templates: reusable command sets, connection templates, config snippets, script integrations or report layouts.
- AI examples: prompts, MCP server workflows, skills or agent setups that get useful results from the rConfig AI features.
- Guides: a procedure, design pattern or worked example for running rConfig in practice.
- Fixes: a wrong command, an outdated screenshot, a broken link or anything else that is incorrect on an existing page.
If you have something useful that doesn't fit these categories, send it anyway.
Product install, upgrade and configuration steps belong in the main documentation. Fixes to those pages are welcome by email too.
What to include in your email
Use a subject line that starts with Guides contribution: followed by a short topic, for exampleGuides contribution: IOS-XE SSH version 2 rule. Then include:
- What it is and why it matters, in a few sentences.
- The content itself: the policy definition, command list or draft text. Attach files rather than pasting long configs into the email body.
- For policy rules, a config that passes and a config that fails, so we can confirm the result in our test suite.
- Where you tested it: vendor, platform, OS version and the rConfig version and edition you used.
- For AI examples, the prompt or workflow, the model or client you used, and a sanitised sample of the output.
- For architectures, a diagram (a photo of a whiteboard is fine) and the rough device count.
- For fixes, the page URL and what should change.
- How you'd like to be credited: your name, your name and company, or anonymously.
Sanitise everything first
- Replace IP addresses with documentation ranges:
192.0.2.0/24,198.51.100.0/24or203.0.113.0/24for IPv4 (RFC 5737), and2001:db8::/32for IPv6 (RFC 3849). - Replace hostnames and domains with
example.comorexample.net. - Replace password hashes, keys, certificates and tokens with obviously fake values.
- Remove customer and company names, serial numbers, asset tags and real SNMP communities.
How we review
- Policy rules are added to our test suite. A rule is only published once a test asserts both the passing and the failing result.
- Platform support is checked against vendor documentation and, where we can, lab equipment.
- Guides and fixes are checked for accuracy against the current release.
We rewrite contributions to match the house style. We may shorten, merge or restructure what you send, and we will not publish marketing copy or claims of regulatory compliance.
Credit and stickers
When your contribution is published, we credit you as you asked and email you to ask for a postal address for your sticker pack. We post anywhere, free of charge. We don't need your address before then.
Permission to publish
By sending a contribution, you confirm it is your own work or that you have the right to share it, and that it contains no confidential information belonging to your employer, your customers or a vendor. You also agree that rConfig may edit it and publish it as part of the documentation.
Ready to send?
Email info@rconfig.com. Questions before you start are welcome at the same address.