Add instance docs

This commit is contained in:
Edward Loveall 2021-11-11 11:31:14 -05:00
parent 3f56fac408
commit 25464acabe
No known key found for this signature in database
GPG key ID: 789A4AE983AC8901
3 changed files with 27 additions and 1 deletions

1
.gitignore vendored
View file

@ -1,4 +1,3 @@
/docs/
/lib/
/bin/
/.shards/

12
docs/instances.md Normal file
View file

@ -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.

View file

@ -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