~edwardloveall/scribe

25464acabeeb75af88b9679b3d2884ecdc136999 — Edward Loveall 6 months ago 3f56fac
Add instance docs
3 files changed, 27 insertions(+), 1 deletions(-)

M .gitignore
A docs/instances.md
M src/pages/faq/index_page.cr
M .gitignore => .gitignore +0 -1
@@ 1,4 1,3 @@
/docs/
/lib/
/bin/
/.shards/

A docs/instances.md => docs/instances.md +12 -0
@@ 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.

M src/pages/faq/index_page.cr => src/pages/faq/index_page.cr +15 -0
@@ 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