Help creating Replicated Documentation For end user Kubernetes installs?

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

Replicated maintains a starter repo for creating documentation and there are 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, airgapped 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!

Starter Template

The Replicated team maintains some starter markdown templates in this repo:

Examples

  1. Enterprise Section in the Replicated documentation: Overview of Installing an Application with the App Manager | Replicated Docs - the markdown sources for this are public in replicated-docs/docs/enterprise at main · replicatedhq/replicated-docs · GitHub
  2. SmartBear / SwaggerHub install documentation: (this is the airgapped guide, but the whole section of their docs is great) Airgapped Installation Into Existing Kubernetes Cluster | SwaggerHub Documentation
  3. Swimlane Platform installer documentation: https://swimlane.com/knowledge-center/install/Swimlane_Platform_Installer/
  4. CircleCI Server v3.x Overview - CircleCI
  5. Self-managed Harness and gitops - Harness Experts - Harness Community
  6. https://docs.gitguardian.com/internal-repositories-monitoring/self_hosting/introduction
  7. https://docs.lightup.ai/lightup-quickstart/deployment/lightup-enterprise-quick-start
  8. Red-Gate - Glossary - Redgate Clone - Product Documentation
  9. Modzy - On-Premise
  10. Wallaroo Cloud Install - https://docs.wallaroo.ai/wallaroo-operations-guide/wallaroo-setup-environment/wallaroo-environment-requirements/
  11. Cased Shell - Cased Shell Admin Portal - Cased Documentation