Illumina Innovates with Rancher and Kubernetes
The Rancher community library contains articles on Rancher products, Kubernetes, container management and orchestration, and related technologies. The following guidelines will help you produce content for our library by matching our style, tone, conventions, and workflow.
To simplify collaboration and publishing, we require article submissions to follow certain general rules.
File Format Rancher tutorials are written as plain text files using the Markdown markup language. Markdown lets you specify how text should be formatted by including formatting indicators within the text itself.
Working as a Rancher Writer Join the Rancher Writers Network Writers share their knowledge by researching and writing detailed technical articles on topics like Kubernetes, CI/CD, cloud-native application development, and more. After agreeing on a subject and an outline, writers conduct research, organize their ideas and write high-quality articles with clear language and detailed explanations. In most cases, Rancher writers conduct their own research, so it’s important that you’re comfortable learning processes and technologies that you're not familiar with.
Working as a Rancher Research Assistant Research assistants are members of the Rancher Writers Network. Research assistants help accelerate the process of producing high quality articles by conducting technical research on interesting topics like Kubernetes, CI/CD, cloud-native application development, and more. After agreeing on a subject, research assistants conduct research, compile notes, and create a detailed article outline. Afterwards, a Rancher writer will use the compiled information to create technical articles for the Rancher community.
To help improve consistency and clarity in the Rancher library, we’ve developed a word usage guide to establish conventions over terminology, ambiguous capitalization, and formatting. When writing articles for Rancher, consult this list to understand the way we use certain words and phrases.
The table below lists our preferred forms, some alternatives we discourage, the context in which these should be applied, and a description to help explain the reasoning behind our choices.
Template to use when writing procedural tutorials for the Rancher community.
Template to use when conducting article research for the Rancher community.
The Rancher Writing Program is a way to show what you know, give back to the community, and earn money by helping us produce great content.
This is an example outline for a Rancher article. The main bullet points represent the sections the author thinks might work well within the article. The nested sub-items represent sub-sections and descriptions of what each section will cover. Providing a detailed outline and project scope helps the content team offer feedback early and helps ensure that everyone is aligned on expectations. An outline does not necessarily have to reflect the final form of the article, but it should have provide enough details and structure for us evaluate your ideas.
This is an example outline for a Rancher article as produced by a research assistant. The main bullet points represent the sections the researcher thinks might work well within the article. The nested sub-items represent sub-sections and descriptions of what each section will cover. Providing a detailed outline, links to sources, and the main points that each section should cover help writers produce coherent, accurate, comprehensive articles on the topic. Outlines produced by researchers should be thoroughly researched, well organized, and detailed.
Template to use when writing conceptual guides for the Rancher community.
Template to use when writing comparison guides for the Rancher community.