From b3fea58c6f9a29ec5fb428d82c25e3a82ac962af Mon Sep 17 00:00:00 2001 From: Matthew Somerville Date: Thu, 27 Sep 2018 14:56:52 +0100 Subject: Move docs from gh-pages branch. --- docs/overview.md | 85 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 85 insertions(+) create mode 100644 docs/overview.md (limited to 'docs/overview.md') diff --git a/docs/overview.md b/docs/overview.md new file mode 100644 index 000000000..a7af0bf15 --- /dev/null +++ b/docs/overview.md @@ -0,0 +1,85 @@ +--- +layout: page +title: Documentation +--- + +Welcome to FixMyStreet Platform +=============================== + +

+ mySociety's open source geographic problem-reporting platform +

+
+
+

Install

+

+ Begin with the installation documentation. Put + FixMyStreet on your own Debian/Ubuntu server, or on Amazon EC2. +

+
+
+

Customise

+

+ FixMyStreet is fully customisable — + change the style, layout, maps, and behaviour of your installation. + It's international too: if FixMyStreet is not already available in your + language, you don't need any hard-core coding skills to provide a new + translation. +

+
+
+
+
+

Run

+

+ Our information for administrators covers + everything you need to do once your FixMyStreet site is up and running. + Help is available on everything from defining admin boundaries to writing common user support + emails. +

+
+
+

Join in or get help

+

+ There's a friendly community comprising + full-time mySociety staff, international volunteers, and people like + you who are already running their own FixMyStreet sites in their own + countries. They're happy to offer technical and non-technical support + — jump in and join! +

+
+
+ +About the FixMyStreet Platform +------------------------------ + +The FixMyStreet Platform is an open source project from +[mySociety](https://www.mysociety.org) to help people run websites for +reporting common street problems such as potholes and broken street lights to +an appropriate authority. It's been [running successfully in the +UK](https://www.fixmystreet.com) since 2007 (in fact, it works so well some UK +councils use it too), and we're still working on making it better. + +FixMyStreet has been copied around the world, and is still under +active development. We work hard to make sure it's easy to +deploy, customise, and run in locations all over the world. + +Could your location use a FixMyStreet site? +------------------------------------------- + + +We've written a clear guide for anyone who's thinking about [setting up and +running FixMyStreet]({{ "/The-FixMyStreet-Platform-DIY-Guide-v1.1.pdf" | relative_url }}). Anyone +thinking of running such a project **must** read it first -- it explains why +these sites work, and what you need to think about before you start. + +If you're thinking of getting involved, we welcome questions about how it +works [on our mailing +list](https://groups.google.com/a/mysociety.org/forum/#!forum/fixmystreet). +Or, if you're outside the UK, email +international@mysociety.org. + +There's also the [FixMyStreet blog](blog/) where we post version release +information and other progress reports. And we often post FixMyStreet news on +the mySociety blog too. -- cgit v1.2.3