aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorAlexandre Hannud Abdo <abdo@member.fsf.org>2014-04-04 19:19:43 -0300
committerAlexandre Hannud Abdo <abdo@member.fsf.org>2014-04-04 19:31:48 -0300
commit022473bf6fbebcd75c9d35add36e7cf9947dabd5 (patch)
tree350665eef5e32a45f1ccd73ba53efb24f8b02998 /doc
parent3f1a78fa690e2220b46823527f3abf0a0d51cd8e (diff)
downloadvolse-hubzilla-022473bf6fbebcd75c9d35add36e7cf9947dabd5.tar.gz
volse-hubzilla-022473bf6fbebcd75c9d35add36e7cf9947dabd5.tar.bz2
volse-hubzilla-022473bf6fbebcd75c9d35add36e7cf9947dabd5.zip
Update documentation on connecting to channels and on documentation.
Diffstat (limited to 'doc')
-rw-r--r--doc/connecting_to_channels.md (renamed from doc/Connecting-to-Channels.md)21
-rw-r--r--doc/to_do_doco.md29
2 files changed, 46 insertions, 4 deletions
diff --git a/doc/Connecting-to-Channels.md b/doc/connecting_to_channels.md
index 4fe2a0789..8a7b0bdde 100644
--- a/doc/Connecting-to-Channels.md
+++ b/doc/connecting_to_channels.md
@@ -1,5 +1,4 @@
-Connecting To Channels
-======================
+# Connecting To Channels #
Connections in the Red Matrix can take on a great many different meanings. But let's keep it simple, you want to be friends with somebody like you are familiar with from social networking. How do you do it?
@@ -13,8 +12,22 @@ Visit their profile by clicking their photograph in the directory, matrix, or co
You may also connect with any channel by visiting the "Connections" page of your site or the Directory and typing their "webbie" into the "Add New Connection" field. Use this method if somebody tells you their webbie and you wish to connect with them. A webbie looks like an email address; for example "bob@example.com". The process is the same as connecting via the "Connect" button - you will then be taken to the connection editor to set permissions.
-**Premium Channels**
+## Block/Ignore/Archive/Hide channels ##
+
+Channels in your address book can have statuses such as *blocked*, *ignored*, *archived* and *hidden*. From your connections page you can see tabs that display the channels with those statuses. From your edit connection pages you can change the statuses of a channel.
+
+Here's their meaning:
+
+**Blocked:** the channel can't read your items regardless of permissions, nor can it write to your channel.
+
+**Ignored:** the channel can read your items if it has permission, but can't write to your channel.
+
+**Hidden:** the channel does not show up in your profile's connections list, noone can see you're connected, but beware they may still show up to your other connections, for example in post replies.
+
+**Archived:** if a channel can't be reached for 30 days, it is automatically marked as archived. This keeps all the data but stops polling the channel for new information and removes it from autocomplete. If later you learn the channel has come back online, you may manually unarchive it.
+
+
+## Premium Channels ##
Some channels are designated "Premium Channels" and **may** require some action on your part before a connection can be established. The Connect button will for these channels will take you to a page which lists in detail what terms the channel owner has set. If the terms are accepted, the connection will then proceed normally. In some cases, such as with celebrities and world-reknowned publishers, this **may** involve payment. If you do not agree to the terms, the connection will not proceed, or it may proceed but with reduced permissions allowed on your interactions with that channel.
- \ No newline at end of file
diff --git a/doc/to_do_doco.md b/doc/to_do_doco.md
new file mode 100644
index 000000000..6e4f17724
--- /dev/null
+++ b/doc/to_do_doco.md
@@ -0,0 +1,29 @@
+# Documentation To-Do List #
+
+## How to contribute documentation ##
+
+Documentation files are in */doc*.
+
+When help is first accessed, the file loaded is *main.bb*. That file contains case sensitive links without an extension. The extensions is added automatically if the file is found, first *.md* then *.bb*.
+
+For translating documentation, create a directory in */doc* named by the language code, copy the files and translate the content.
+
+## Documentation we need to write ##
+
+* Database schema detailed descriptions
+
+* Complete plugin hook documentation
+
+* API documentation
+
+* Function and code documentation (doxygen)
+
+* New Member guide
+
+* &quot;Extra Feature&quot; reference, description of each
+
+* Detailed Personal Settings Documentation
+
+* Administration Guide (post-install)
+
+* Administration Guide (pre-install)