From f6118ed6a8c79c9b6a89890e610771521d0f62e2 Mon Sep 17 00:00:00 2001
From: Petr Kalis <petr.kalis@gmail.com>
Date: Thu, 18 May 2023 17:42:37 +0200
Subject: [PATCH] Added docuumentation

---
 website/docs/admin_settings_system.md |  4 +++
 website/docs/module_royalrender.md    | 37 +++++++++++++++++++++++++++
 website/sidebars.js                   |  1 +
 3 files changed, 42 insertions(+)
 create mode 100644 website/docs/module_royalrender.md

diff --git a/website/docs/admin_settings_system.md b/website/docs/admin_settings_system.md
index d61713ccd5..8abcefd24d 100644
--- a/website/docs/admin_settings_system.md
+++ b/website/docs/admin_settings_system.md
@@ -102,6 +102,10 @@ workstation that should be submitting render jobs to muster via OpenPype.
 
 **`templates mapping`** - you can customize Muster templates to match your existing setup here.
 
+### Royal Render
+
+**`Royal Render Root Paths`** - multi platform paths to Royal Render installation.
+
 ### Clockify
 
 **`Workspace Name`** - name of the clockify workspace where you would like to be sending all the timelogs.
diff --git a/website/docs/module_royalrender.md b/website/docs/module_royalrender.md
new file mode 100644
index 0000000000..2b75fbefef
--- /dev/null
+++ b/website/docs/module_royalrender.md
@@ -0,0 +1,37 @@
+---
+id: module_royalrender
+title: Royal Render Administration
+sidebar_label: Royal Render
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+
+## Preparation
+
+For [Royal Render](hhttps://www.royalrender.de/) support you need to set a few things up in both OpenPype and Royal Render itself
+
+1. Deploy OpenPype executable to all nodes of Royal Render farm. See [Install & Run](admin_use.md)
+
+2. Enable Royal Render Module in the [OpenPype Admin Settings](admin_settings_system.md#royal-render).
+
+3. Point OpenPype to your Royal Render installation in the [OpenPype Admin Settings](admin_settings_system.md#royal-render).
+
+4. Install our custom plugin and scripts to your RR repository. It should be as simple as copying content of `openpype/modules/royalrender/rr_root` to `path/to/your/royalrender/repository`.
+
+
+## Configuration
+
+OpenPype integration for Royal Render consists of pointing RR to location of Openpype executable. That is being done by copying `_install_paths/OpenPype.cfg` to
+RR root folder. This file contains reasonable defaults. They could be changed in this file or modified Render apps in `rrControl`.
+
+
+## Debugging
+
+Current implementation uses dynamically build '.xml' file which is stored in temporary folder accessible by RR. It might make sense to
+use this Openpype built file and try to run it via `*__rrServerConsole` executable from command line in case of unforeseeable issues.
+
+## Known issues
+
+Currently environment values set in Openpype are not propagated into render jobs on RR. It is studio responsibility to synchronize environment variables from Openpype with all render nodes for now.
diff --git a/website/sidebars.js b/website/sidebars.js
index 4874782197..c846b04ca7 100644
--- a/website/sidebars.js
+++ b/website/sidebars.js
@@ -111,6 +111,7 @@ module.exports = {
                 "module_site_sync",
                 "module_deadline",
                 "module_muster",
+                "module_royalrender",
                 "module_clockify",
                 "module_slack"
             ],