Update docs

adzialocha · Apr 24, 2019 · d6d1f3f · d6d1f3f
1 parent c8f600c
commit d6d1f3f
Show file tree

Hide file tree

Showing 25 changed files with 213 additions and 58 deletions.
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -12,8 +12,8 @@ Conversation.belongsToMany(Animal, {
 })
 ```
 
-Do you want to install HOFFNUNG 3000 on your own server? Read the [installation manual](/installation.html).
+Do you want to **install HOFFNUNG 3000** on your own server? Read the [installation manual](/installation.html).
 
-Do you want to know more about what you can do with HOFFNUNG 3000 and how to use it? Read the [usage guide](/usage-guide.html).
+Do you want to know more about what you can do with HOFFNUNG 3000 and **how to use it?** Read the [usage guide](/usage-guide.html).
 
-Learn more about HOFFNUNG 3000 [here](https://blatt3000.de/hoffnung3000/), [here](https://github.com/adzialocha/hoffnung3000), [here](https://soundcloud.com/thelakeradio/a-portrait-of-blatt-3000) or [here](https://www.youtube.com/watch?v=ux2R9jwEIgw).
+**Learn more** about HOFFNUNG 3000 and read about [BLATT 3000](https://blatt3000.de/hoffnung3000/), look at the [source code](https://github.com/adzialocha/hoffnung3000), listen to a [radio play about the festival](https://soundcloud.com/thelakeradio/a-portrait-of-blatt-3000) or watch [this clip](https://www.youtube.com/watch?v=ux2R9jwEIgw).
diff --git a/docs/images/activity-stream.png b/docs/images/activity-stream.png
diff --git a/docs/images/admin-configs-2.png b/docs/images/admin-configs-2.png
diff --git a/docs/images/admin-configs.png b/docs/images/admin-configs.png
diff --git a/docs/images/admin-edit-page.png b/docs/images/admin-edit-page.png
diff --git a/docs/images/admin-edit-user.png b/docs/images/admin-edit-user.png
diff --git a/docs/images/admin-pages.png b/docs/images/admin-pages.png
diff --git a/docs/images/admin-users.png b/docs/images/admin-users.png
diff --git a/docs/images/screenshot-calendar.png → docs/images/calendar.png b/docs/images/screenshot-calendar.png → docs/images/calendar.png
diff --git a/docs/images/create-event.png b/docs/images/create-event.png
diff --git a/docs/images/create-place-2.png b/docs/images/create-place-2.png
diff --git a/docs/images/screenshot-create-place.png → docs/images/create-place.png b/docs/images/screenshot-create-place.png → docs/images/create-place.png
diff --git a/docs/images/new-message.png b/docs/images/new-message.png
diff --git a/docs/images/new-resource.png b/docs/images/new-resource.png
diff --git a/docs/images/overview.png b/docs/images/overview.png
diff --git a/docs/images/registration.png b/docs/images/registration.png
diff --git a/docs/images/screenshot-resources.png → docs/images/resources.png b/docs/images/screenshot-resources.png → docs/images/resources.png
diff --git a/docs/images/screenshot-select-resources.png → docs/images/select-resources.png b/docs/images/screenshot-select-resources.png → docs/images/select-resources.png
diff --git a/docs/images/screenshot-select-slots.png → docs/images/select-slots.png b/docs/images/screenshot-select-slots.png → docs/images/select-slots.png
diff --git a/docs/images/screenshot-sidebar.png → docs/images/sidebar.png b/docs/images/screenshot-sidebar.png → docs/images/sidebar.png
diff --git a/docs/images/slot-editor.png b/docs/images/slot-editor.png
diff --git a/docs/images/screenshot-stream.png → docs/images/stream.png b/docs/images/screenshot-stream.png → docs/images/stream.png
diff --git a/docs/index.md b/docs/index.md
@@ -4,27 +4,38 @@ title: Introduction
 order: 0
 ---
 
-HOFFNUNG 3000 was a festival for music, art and theory in Berlin initiated by [BLATT 3000](https://blatt3000.de) together with [KLANGkELLER](http://klangkeller.net/) in [Berlin 2017](https://soundcloud.com/thelakeradio/a-portrait-of-blatt-3000). It was an experiment in social, artistic and theoretical collaboration.
+HOFFNUNG 3000 is a web-based [platform](http://github.com/adzialocha/hoffnung3000) on which participants organize the festival themselves by offering and sharing and using everyone’s abilities / potentials / gear / skills. The idea was and is, that all these resources form a diverse pool of potentiality and it is from these resources that all activity and production derive. The festival is created by everyone’s collective endeavour.
 
-HOFFNUNG 3000 is also a [platform](http://github.com/adzialocha/hoffnung3000) on which participants organize the festival themselves by offering and sharing and using everyone’s abilities / potentials / gear / skills. The idea was and is, that all these resources form a diverse pool of potentiality and it is from these resources that all activity and production derive. The festival is created by everyone’s collective endeavour.
+HOFFNUNG 3000 was also a festival for music, art and theory in Berlin initiated by [BLATT 3000](https://blatt3000.de) together with [KLANGkELLER](http://klangkeller.net/) in [Berlin 2017](https://soundcloud.com/thelakeradio/a-portrait-of-blatt-3000). It was an experiment in social, artistic and theoretical collaboration.
 
 HOFFNUNG 3000 asks: How do we organize ourselves in our social, artistic & theoretical communities? HOFFNUNG 3000 is not simply a festival but more of a process of organizing a festival, a festival that creates itself. Through each and every participant.
 
+## Features
+
+* Register `resources` (skills, items, etc.) and make them available to other users
+* Create `places` (address, gps position or *virtual*) and define time slots, so other users can organize events there
+* Organize `events` in `places` and use `resources` of others to realize them
+* Users can be anonymized with randomly generated [animal avatars](https://github.com/adzialocha/random-animal-name-generator/)
+* Have random meetings with random participants in random places
+* Built-in messenger and activity stream
+* `events` and `places` can be private (not visible to audience) or public
+* [.gif-stream](https://github.com/adzialocha/gif-stream/blob/master/example.gif) documentation tool
+
 ## Screenshots
 
-![HOFFNUNG 3000 Calendar](/images/screenshot-calendar.png)
+![HOFFNUNG 3000 Calendar](/images/calendar.png)
 
-![HOFFNUNG 3000 Create new place](/images/screenshot-create-place.png)
+![HOFFNUNG 3000 Create new place](/images/create-place.png)
 
-![HOFFNUNG 3000 Resources list](/images/screenshot-resources.png)
+![HOFFNUNG 3000 Resources list](/images/resources.png)
 
-![HOFFNUNG 3000 Select resources for event](/images/screenshot-select-resources.png)
+![HOFFNUNG 3000 Select resources for event](/images/select-resources.png)
 
-![HOFFNUNG 3000 Select slots for event](/images/screenshot-select-slots.png)
+![HOFFNUNG 3000 Select slots for event](/images/select-slots.png)
 
-![HOFFNUNG 3000 Sidebar](/images/screenshot-sidebar.png)
+![HOFFNUNG 3000 Sidebar](/images/sidebar.png)
 
-![HOFFNUNG 3000 .gif Stream](/images/screenshot-stream.png)
+![HOFFNUNG 3000 .gif Stream](/images/stream.png)
 
 ## Getting started
 

diff --git a/docs/installation.md b/docs/installation.md
@@ -13,9 +13,9 @@ There are different ways on how to install HOFFNUNG 3000. We tried to keep the t
 
 1. Register a new account on [Heroku](https://www.heroku.com) if you don't already have one
 
-2. Click the following button to automatically deploy HOFFNUNG 3000 and a database on your Heroku server:
+2. Click the following link to automatically deploy HOFFNUNG 3000 and a database on your Heroku server:
 
-    [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/adzialocha/hoffnung3000)
+    [https://heroku.com/deploy?template=https://github.com/adzialocha/hoffnung3000](https://heroku.com/deploy?template=https://github.com/adzialocha/hoffnung3000)
 
 3. Choose a name and region, then click `Deploy app`. Wait until the installation finished on your server
 
@@ -29,6 +29,8 @@ Please note that **this simple setup is not recommended for official festival se
 
 For this setup we assume you already have a running [NodeJS server environment](https://www.digitalocean.com/community/tutorials/how-to-set-up-a-node-js-application-for-production-on-ubuntu-16-04), SMTP mail server and a [PostgreSQL database](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-on-ubuntu-16-04) installed.
 
+You can find the source code of HOFFNUNG 3000 in a git repository hosted on: [github.com/adzialocha/hoffnung3000](https://github.com/adzialocha/hoffnung3000).
+
 ### Requirements
 
 * Server with [NodeJS](https://nodejs.org/en/) environment (tested with v10.12.0)
@@ -97,7 +99,7 @@ npm run db:migrate
 npm run db:seed
 ```
 
-The seed will create a default admin user with email: `[email protected]` and passwort: `adminadmin`. Please change the credentials after first login in the admin panel.
+The seed will create a default admin user with email: `[email protected]` and passwort: `adminadmin`. Please [change the credentials](/usage-guide.html#change-the-default-admin-user) after first login in the admin panel.
 
 ### 4. Start server