# Help creating Replicated Documentation For end user Kubernetes installs? **URL:** \ **Category:** Packaging an application\ **Created:** [June 8, 2022, 1:51pm UTC](https://community.replicated.com/t/help-creating-replicated-documentation-for-end-user-kubernetes-installs/811 "2022-06-08T13:51:29Z")\ **Posts on this page:** 2\ **Page:** 1
**Author:** ![dex](https://yyz2.discourse-cdn.com/flex030/user_avatar/community.replicated.com/dex/32/26_2.png) [@dex](https://community.replicated.com/u/dex)\ **Post date:** [June 8, 2022, 1:51pm UTC](https://community.replicated.com/t/help-creating-replicated-documentation-for-end-user-kubernetes-installs/811/1 "2022-06-08T13:51:29Z")
> 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? ---
**Author:** ![dex](https://yyz2.discourse-cdn.com/flex030/user_avatar/community.replicated.com/dex/32/26_2.png) [@dex](https://community.replicated.com/u/dex)\ **Post date:** [July 25, 2022, 8:22pm UTC](https://community.replicated.com/t/help-creating-replicated-documentation-for-end-user-kubernetes-installs/811/2 "2022-07-25T20:22:41Z")
To get started, check out our [blog on how to write great docs](https://www.replicated.com/blog/writing-great-documentation-for-on-prem-software-distributed-with-replicated) 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. > **[Writing Great Documentation for On-Prem Software Distributed with Replicated](https://www.replicated.com/blog/writing-great-documentation-for-on-prem-software-distributed-with-replicated)** > > Learn how to create effective documentation for on-premises software distributed with Replicated. Discover strategies for installation guides, troubleshooting, and managing diverse deployment scenarios. ### 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](https://github.com/replicatedhq/vendor-docs-starter/blob/main/README.md) 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](https://www.replicated.com/blog/writing-great-documentation-for-on-prem-software-distributed-with-replicated). [![](https://canada1.discourse-cdn.com/flex030/uploads/replicated/original/1X/93fb35b33c1e73bf328a93282b9e0bc3c5e932ed.jpeg "Creating install docs for your customers from RepliCon Q3 2022") ](https://www.youtube.com/watch?v=4nybzbhr1S8) ### Examples 1. The Replicated KOTS documentation: [Considerations Before Installing | Replicated Docs](https://docs.replicated.com/enterprise/installing-overview) - the markdown source for this is public at [replicated-docs/docs/enterprise at main · replicatedhq/replicated-docs · GitHub](https://github.com/replicatedhq/replicated-docs/tree/main/docs/enterprise). 2. SmartBear / SwaggerHub install documentation: [Install Swagger Studio On-Premise 2.x | SwaggerHub Documentation](https://support.smartbear.com/swaggerhub/docs/en/on-premise-administrator-guide/installing-swaggerhub-on-premise-2-x--kubernetes-/install-swaggerhub-on-premise-2-x.html?sbsearch=install) 3. KNIME - [KNIME Business Hub Installation Guide - Embedded Cluster](https://docs.knime.com/latest/business_hub_installation_guide/index.html#_install_the_embedded_cluster_for_knime_business_hub) 4. DataStax - [Mission Control | DataStax Docs](https://docs.datastax.com/en/mission-control/docs/index.html) 5. GitGuardian - [https://docs.gitguardian.com/internal-repositories-monitoring/self\_hosting/introduction](https://docs.gitguardian.com/internal-repositories-monitoring/self_hosting/introduction) 6. Plotly - [GitBook](https://plotly.gitbook.io/dash-enterprise-admin-docs/installation/dash-enterprise-kubernetes) 7. TravisCI - [Setup Travis CI Enterprise 3.x - Travis CI](https://docs.travis-ci.com/user/enterprise/tcie-3.x-setting-up-travis-ci-enterprise/) 8. Wallaroo - [https://docs.wallaroo.ai/wallaroo-platform-operations/wallaroo-platform-operations-install/wallaroo-platform-operations-installation/wallaroo-platform-operations-install-cluster/wallaroo-platform-operations-install-cluster-kubernetes/wallaroo-install-cluster-prerequisites/](https://docs.wallaroo.ai/wallaroo-platform-operations/wallaroo-platform-operations-install/wallaroo-install-prerequisites/) 9. Wickr - [Installing Wickr Enterprise - Wickr Enterprise](https://docs.aws.amazon.com/wickr/latest/wickrenterpriseinstall/installing.html)