Article

Table of Contents
Theme:
Was this article helpful?

2  out of  4 found this helpful

Try Vultr Today with

$50 Free on Us!

Want to contribute?

You could earn up to $300 by adding new articles!

Vultr Docs Program Guidelines

Last Updated: Thu, Aug 20, 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 that need extensive editing or have technical errors are not accepted.
  • Articles submitted to Vultr are exclusive to Vultr Docs. Do not republish the article elsewhere—before or after submission—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.

Permitted Topics

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

  • Installation Guides are 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. We have an example template to use when writing an installation guide.
  • 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 are short documents that explain the best possible way to do a particular task. Installation guides frequently link to these for frequent tasks.
  • 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 are common questions with short answers, rarely more than one paragraph, and link to other documents as much as possible.

Not every topic will be accepted for publication, even if it technically meets the program guidelines for grammar and style. For example, installation guides that merely summarize the installation steps are unlikely to be accepted because they should also include configuration information and best practices for the user. We are happy to review your topic idea and give suggestions if you submit an article outline with a note requesting feedback.

Ports

Ports are existing topics adapted to a different platform. 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 add new information beyond substituting yum for apt. We prioritize original articles over ports. We may not publish some port submissions even if they meet the program guidelines. Please submit an article outline for feedback before writing a port. As a guideline, if a port is low-effort to write, it may be low-value to publish.

Unpermitted Topics

We do not publish articles regarding:

  • 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.
  • Guides for any product if the primary use will typically violate Vultr's Acceptable Use Policy. For example, media servers, robodialers, shopping bots, etc.

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.
  • 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.
  • Explain how to locate the latest version of a software package and avoid links to a specific version unless required.
  • Use example domains and IP addresses described in rfc5737, rfc3849, and rfc6761:
  • Your article should assume high security whenever possible. If your guide uses HTTP, also include HTTPS instructions. Use a free SSL/TLS certificate from Let's Encrypt at a minimum. If your article uses SSH, use SSH keys instead of passwords.

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. 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 post it elsewhere in any form, modified or unmodified.

Payments and Rates

Vultr Docs payments are based on the amount of original writing, and exclude code blocks. We may edit articles for clarity, and the article length may change significantly during the editing process. We base payouts on the final article length and the editing effort required for publication. These payment rates are guidelines; we evaluate each article individually. Adding two words to a 749-word article does not instantly transform it from a $75 payout to a $150 payout, for example. We will present a payment offer and obtain your consent before publishing.

  • Articles greater than 1500 words are eligible for up to $300.
  • Articles between 750 to 1500 words are eligible for up to $150.
  • Articles less than 750 words are eligible for up to $75.
  • Ports of existing articles are eligible for up to $75.
  • We accept updates to existing articles, with pre-approval. The amount of new content determines the payout offered.
  • We review your account 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