Vultr Docs Program Guidelines

Last Updated: Wed, Jul 29, 2020
Vultr Docs

Program Overview

Vultr Docs is a knowledge base for the Vultr community, and we appreciate your submissions! We have a thorough review process to ensure the highest-quality information. Please review this guide and the other program resources carefully.

Program Rules

  • Articles must be in English, with proper spelling and grammar. See our style guide for more information.
  • You must submit original content. Do not plagiarize from other Vultr Docs or other sites.
  • Articles submitted to Vultr are exclusive to the Vultr Docs program. Do not republish the article on other websites, communities, or knowledge archives, before or after submission to Vultr, with or without modification.
  • After payment, the content becomes the property of Vultr. We may reuse the content as needed, or rewrite to improve readability.
  • Do not mention other providers that offer similar services to Vultr.
  • Use a minimum number of URL links to resources outside of Vultr Docs.
  • Violations of any program rules may lead to suspension from the Docs program and disqualify future submissions.

Acceptable Topics

Users reading your articles are primarily interested in server administration and applications. Our documentation library consists of these major categories:

  • Installation Guides
    • Step-by-step installation and configuration instructions. The majority of our documents are installation guides. They should frequently link to our quickstart guides and best practices rather than repeat standard instructions. They are logically arranged into categories. This template is a good resource when writing an installation guide.
  • Quickstart Guides
    • Quickstart guides supplement documentation by following the 80/20 rule. For any topic, a quickstart guide provides the most popular 20% of the information to solve 80% of the issues. Quickstart guides are useful for users who know what they want to do but need a cheat-sheet for how to do it. For example, they know they need to open a port in a firewall but don't know the exact command.
  • Best Practices
    • Best practices are short documents that explain the best possible way to do a particular task. Installation guides frequently link to these for common tasks.
  • Troubleshooting Guides
    • Troubleshooting guides are step-by-step instructions to resolve common problems. They should link to quickstart guides and best practice guides as much as possible. The quickstart guides and best practices explain what to do. Troubleshooting guides explain how to use those techniques to solve a problem.
  • Frequently Asked Questions
    • FAQs are common questions with short answers, rarely more than one paragraph, and link to other documents as much as possible.
  • Ports
    • A port is an existing topic adapted to a different platform. See this example. Ports are appropriate if the procedure is significantly different, such as Ubuntu to FreeBSD. We do not publish ports that are substantially the same. For example, Debian 9 to Debian 10 procedures are identical in most cases. When porting an article, please include additional configuration or other content for the reader. For example, an installation guide ported from Ubuntu to CentOS should elaborate on the previous article, not just substitute yum for apt. We prioritize original articles and may not publish some port submissions even if they meet the program guidelines. We recommend submitting an article outline for feedback before writing a port.

Not every topic will be accepted for publication, even if it technically meets the other program guidelines for grammar and style. For example, articles that repeat basic installation instructions from the source product without significant additional information are unlikely to be accepted. We are happy to review your topic idea and give suggestions if you submit an article outline and include a note asking for feedback.

Banned Topics

  • How to bypass or "crack" licensing systems of applications.
  • Peer-to-peer sharing guides for programs such as BitTorrent, etc.
  • Anonymous surfing guides for programs such as Tor, Shadowsocks, SOCKS5, or other proxy software.
  • Game guides focusing on SteamCMD installation. Game guides should concentrate on using and customizing the game server. Link to this article as a reference to describe SteamCMD installation.
  • Blockchain and cryptocurrencies
  • Guides that require virtualization technologies (VirtualBox, VMWare, KVM, XEN, etc.) Vultr does not support nested virtualization.

Writing Tips

  • Test your instructions on a new virtual server. The Vultr Docs team will provision a new server and test your article, exactly as written, step-by-step.
  • When writing a guide for an operating system, target a specific version such as Ubuntu 18.04. Targeting an OS family, like Ubuntu, causes frustration when commands go stale over time.
  • Use example domains and IP addresses. You'll find a list of approved IP blocks and domain names below.
  • When describing everyday tasks such as adding a sudo user, or updating the server, link to one of our reference articles or best practices guides.
  • Please test all hyperlinks. We cannot publish articles with broken hyperlinks.
  • It's usually better to explain how to locate the latest version of a software package than to link to a specific version. Avoid links to a particular version unless you have a good reason for insisting on that version.

Example Domains and IP Addresses

When an example IP address or domain name is needed in your article, please use:

For details about domains and IPs reserved for documentation, please see:

Suggested Templates

Format your article submission in Vultr-flavored Markdown. Use our Installation Guide Template as a formatting example. Before submitting your article, use the Preview tab on the submission page to check your formatting.

Markdown Tutorial

When writing for the Vultr Docs library, use Markdown format. Use our Markdown tutorial as a reference when formatting your article.

Style Guide

Vultr's documentation library contains hundreds of articles written by many authors. Documentation should be clear and easy to understand, without needless slang and jargon. Just as programmers need reference material when writing software, authors need guidelines for style, formatting, and vocabulary. Use our Style Guide as a reference when writing documentation.

Submission Process

We perform an initial screening of article submissions to Vultr Docs to check spelling, formatting, grammar, plagiarism, and topic suitability. We will notify you of the status of the article at this point.

The Vultr Docs team performs a full technical review of articles that pass the initial screening. We test all the steps exactly as written. The article must pass this test without errors to be accepted. Depending on the number of pending submissions, the process may take a few weeks. Please allow sufficient time for our team to complete your review. We edit for clarity and brevity. The article length may change significantly during the editing process.

We base our payment rates on both the final, edited, article length, and the editing effort required for publication. If the editors approve the article, they will send you a payment proposal which you may accept or decline. If you accept and we publish your article, you agree not to publish it elsewhere in any form, modified or unmodified.

Payments and Rates

  • New, original topics of 1500+ words (excluding code) are eligible for up to $300.
  • New, original topics of 750+ words (excluding code) are eligible for up to $150.
  • New, original topics of less than 750 words (excluding code) are eligible for up to $75.
  • Ports of existing topics to a different OS/platform are eligible for up to $75.
  • We reduce payments if the article requires editing for grammar or formatting.
  • Articles that need extensive editing or have technical errors are not accepted.
  • Your account will be reviewed for payment eligibility.
  • For PayPal payouts, your PayPal account must allow you to receive payments. We do not process PayPal requests (to Vultr) or donation pages.

Summary

Thank you for contributing to our document collection! We aim to be a high-quality resource for the entire Vultr community. If you see an error in our documentation, please use the Suggest an update button below each Vultr Doc. If you have a question about the Vulr Docs program, please contact us. We appreciate your feedback.

Want to contribute?

You could earn up to $300 by adding new articles