From 25464acabeeb75af88b9679b3d2884ecdc136999 Mon Sep 17 00:00:00 2001
From: Edward Loveall <edward@edwardloveall.com>
Date: Thu, 11 Nov 2021 11:31:14 -0500
Subject: [PATCH] Add instance docs
---
.gitignore | 1 -
docs/instances.md | 12 ++++++++++++
src/pages/faq/index_page.cr | 15 +++++++++++++++
3 files changed, 27 insertions(+), 1 deletion(-)
create mode 100644 docs/instances.md
diff --git a/.gitignore b/.gitignore
index 63f809f..66e282f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,3 @@
-/docs/
/lib/
/bin/
/.shards/
diff --git a/docs/instances.md b/docs/instances.md
new file mode 100644
index 0000000..c0b0d93
--- /dev/null
+++ b/docs/instances.md
@@ -0,0 +1,12 @@
+# Instances
+
+* <https://scribe.rip> (official)
+* <https://scribe.nixnet.services>
+
+## How do I get my instance on this list?
+
+Check out the [Contributing portion of the README](../README.md#contributing) and submit a patch to this file.
+
+## How do I start my own instance?
+
+There's no documentation at this time. If you have some server know-how, give it a shot. If you run into trouble, feel free to contact the [mailing list](https://lists.sr.ht/~edwardloveall/scribe) for help.
diff --git a/src/pages/faq/index_page.cr b/src/pages/faq/index_page.cr
index 6ea37ee..354f577 100644
--- a/src/pages/faq/index_page.cr
+++ b/src/pages/faq/index_page.cr
@@ -8,6 +8,7 @@ class Faq::IndexPage < MainLayout
article do
auto_redirect
why_would_i_want_this
+ other_instances
mount Shared::LayoutFooter
end
end
@@ -84,4 +85,18 @@ class Faq::IndexPage < MainLayout
end
end
end
+
+ private def other_instances
+ section do
+ h2 "Can I use Scribe on a different website? (instances)"
+ para do
+ text "You can! See "
+ a(
+ "this list",
+ href: "https://git.sr.ht/~edwardloveall/scribe/tree/main/docs/instances.md"
+ )
+ text " in the documentation."
+ end
+ end
+ end
end