From f45a71bca6dce21bcca65af7674246a83860b2fe Mon Sep 17 00:00:00 2001
From: Robert Hensing <robert@roberthensing.nl>
Date: Sun, 29 May 2022 18:42:42 +0200
Subject: [PATCH] Write a bit about integrations

---
 site/index.html | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/site/index.html b/site/index.html
index 32dd855..271133f 100644
--- a/site/index.html
+++ b/site/index.html
@@ -41,6 +41,24 @@
     <a href="https://github.com/hercules-ci/flake-parts/blob/main/ChangeLog.md">ChangeLog</a>
   </p>
 
+  <p>
+    Integrations:
+  </p>
+  <ul>
+    <li><code>github:hercules-ci/hercules-ci-effects</code></li>
+    <li><code>github:hercules-ci/pre-commit-hooks.nix/flakeModule</code></li>
+  </ul>
+
+  <h2>Write your own integration</h2>
+
+  <p>
+    For a general introduction to modules, you can read <a href="https://nixos.org/manual/nixos/stable/index.html#sec-writing-modules">Writing Modules</a> in the NixOS manual, though it goes into NixOS specifics quite quickly. Instead of <code>services.&ltname>.*</code>, etc, we have our own <a href="./options.html">options</a>.
+  </p>
+
+  <p>
+    Writing modules in a distributed ecosystem can be a bit different. If you're inclined to write to some other module's options, consider whether those will be loaded and whether your integration idea is always desirable. If it's not always desirable, consider splitting it off into an extra module, e.g. <code>flakeModules.someOther</code>. Otherwise check if it's loaded: <code>lib.optionalAttrs (options?some.other.option)</code>. You can ask <code>@roberth</code> on GitHub.
+  </p>
+
 </body>
 
 </html>
\ No newline at end of file