Help creating Replicated Documentation For end user Kubernetes installs?

Packaging an application
1

Does Replicated have any resources to help me generate example or starter documentation that I can whitelabel for my end customers to use when installing my app?

1 Like
2

To get started, check out our blog on how to write great docs for software distributed with Replicated. There are also a lot of really good examples in the wild that you can pull from for inspiration.

Before you Start

My biggest warning / piece of advice - DO NOT try to document every installation path to start. Pick one customer environment to ship to (single node online, existing cluster EKS, air gap RHEL in VSphere) and test/document/deploy that really well. Then move on to testing/documenting your next flavor of target environment. Trying to make your documentation too general at the outset is a good way to build something tangled that will confuse your users and cause more problems than it solves!

Blog: Writing Great Documentation for On-Prem Software Distributed with Replicated

This blog provides recommendations on how to write and publish docs, including guidance specific to vendors that distribute their apps with Replicated/KOTS. It gives suggestions for how to set up a docs site, apply a style guide, and organize content, plus some examples and templates.

RepliCon talk: Creating installation docs for your users

Watch a short presentation that provides guidance and suggestions for how to create great installation docs.

Note: The vendor-docs-starter repo mentioned in this talk has been deprecated and is no longer maintained. For up-to-date guidance on writing documentation for applications distributed with Replicated, including examples and templates, see Writing Great Documentation for On-Prem Software Distributed with Replicated.

Examples

  1. The Replicated KOTS documentation: About Installing an Application | Replicated Docs - the markdown source for this is public at replicated-docs/docs/enterprise at main · replicatedhq/replicated-docs · GitHub.
  2. SmartBear / SwaggerHub install documentation: Install SwaggerHub On-Premise 2.x | SwaggerHub Documentation
  3. KNIME - KNIME Business Hub Installation Guide - Embedded Cluster
  4. DataStax - Mission Control | DataStax Docs
  5. GitGuardian - https://docs.gitguardian.com/internal-repositories-monitoring/self_hosting/introduction
  6. Plotly - Dash Enterprise Kubernetes | Dash Enterprise Administration
  7. TravisCI - Setting up Travis CI Enterprise 3.x - Travis CI
  8. Wallaroo - Wallaroo Prerequisites Guide | Wallaroo.AI (Version 2024.1)
  9. Wickr - Installing Wickr Enterprise - Wickr Enterprise