Improvements to help pages

6 files changed, 51 insertions, 44 deletions

diff --git a/doc/admins.bb b/doc/admins.bb
index 484212024..6c78ce999 100644
--- a/doc/admins.bb
+++ b/doc/admins.bb
@@ -1,15 +1,15 @@
 [h2]Documentation for Hub Administrators[/h2]
-
-[h3]Administrators[/h3]
-
+[h3]Deploying your hub[/h3]
 [zrl=[baseurl]/help/install]Install[/zrl]
 [zrl=[baseurl]/help/red2pi]Installing $Projectname on the Raspberry Pi[/zrl]
 [zrl=[baseurl]/help/Hubzilla_on_OpenShift]$Projectname on OpenShift[/zrl]
+[h3]Taking care of your hub[/h3]
 [zrl=[baseurl]/help/troubleshooting]Troubleshooting Tips[/zrl]
+[zrl=[baseurl]/help/theme_management]Theme Management[/zrl]
 [zrl=[baseurl]/help/hidden_configs]Tweaking $Projectname's Hidden Configurations[/zrl]
-[zrl=[baseurl]/help/faq_admins]FAQ For Admins[/zrl]
 [zrl=[baseurl]/help/service_classes]Service Classes[/zrl]
 [zrl=[baseurl]/help/directories]Working with and configuring Directories[/zrl]
-[zrl=[baseurl]/help/theme_management]Theme Management[/zrl]
-
+[h3]Frequently asked questions[/h3]
+[zrl=[baseurl]/help/faq_admins]FAQ For Admins[/zrl]
 
+#include doc/macros/main_footer.bb;
diff --git a/doc/channels.bb b/doc/channels.bb
index 4b47b61dc..14d588266 100644
--- a/doc/channels.bb
+++ b/doc/channels.bb
@@ -1,19 +1,23 @@
-[b]Channels[/b]

+[h2]Channels[/h2]

+

+[h3]What are channels?[/h3]

 

 Channels are simply collections of content stored in one place. A channel can represent anything. It could represent you, a website, a forum, photo albums, anything. For most people, their first channel with be "Me".

 

 The most important features for a channel that represents "me" are:

+[ul]

+[*]Secure and private "spam free" communications

 

-Secure and private "spam free" communications

-

-Identity and "single-signon" across the entire network

+[*]Identity and "single-signon" across the entire network

 

-Privacy controls and permissions which extend to the entire network

-

-Directory services (like a phone book)

+[*]Privacy controls and permissions which extend to the entire network

 

+[*]Directory services (like a phone book)

+[/ul]

 In short, a channel that represents yourself is "me, on the internet".

 

+[h3]Creating channels[/h3]

+

 You will be required to create your first channel as part of the sign up process. You can also create additonal channels from the "Select channel" link.

 

 You will be asked to provide a channel name, and a short nick name. For a channel that represents yourself, it is a good idea to use your real name here to ensure your friends can find you, and connect to your channel. The short nickname will be used to generate a "webbie". This is a bit like a username, and will look like an email address, taking the form nickname@domain. You should put a little thought into what you want to use here. Imagine somebody asking for your webbie and having to tell them it is "llamas-are_kewl.123". "llamasarecool" would be a much better choice.

@@ -22,9 +26,14 @@ Once you have created your channel, you will be taken to the settings page, wher
 

 Once you have done this, your channel is ready to use. At [observer=1][observer.url][/observer][observer=0]example.com/channel/username[/observer] you will find your channel "stream". This is where your recent activity will appear, in reverse chronological order. If you post in the box marked "share", the entry will appear at the top of your stream. You will also find links to all the other communication areas for this channel here. The "About" tab contains your "profile", the photos page contain photo albums, and the events page contains events share by both yourself and your contacts.

 

+[h3]The grid, permissions and delegation[/h3]

+

 The "Grid" page contains all recent posts from across the $Projectname network, again in reverse chronologial order. The exact posts that appear here depend largely on your permissions. At their most permissive, you will receive posts from complete strangers. At the other end of the scale, you may see posts from only your friends - or if you're feeling really anti-social, only your own posts.

 

-As mentioned at the start, many other kinds of channel are possible, however, the creation procedure is the same. The difference between channels lies primarily in the permissions assigned. For example, a channel for sharing documents with colleagues at work would probably want more permissive settings for "Can write to my "public" file storage" than a personal account. For more information, see the permissions section.

+As mentioned at the start, many other kinds of channel are possible, however, the creation procedure is the same. The difference between channels lies primarily in the permissions assigned. For example, a channel for sharing documents with colleagues at work would probably want more permissive settings for "Can write to my "public" file storage" than a personal account. For more information, see the [zrl=[baseurl]/help/roles]permissions section[/zrl].

+

+You can also delegate control of your channels' posts and connections, but not its configurations, to another channel. That is done by editing a connection and assigning it the permission to administer your channel's resources.

 

 #include doc/macros/main_footer.bb;

 

+

diff --git a/doc/external-resource-links.bb b/doc/external-resource-links.bb
index 412e84467..a679e9381 100644
--- a/doc/external-resource-links.bb
+++ b/doc/external-resource-links.bb
@@ -1,20 +1,21 @@
-[b]External Resource Links[/b]

-

-[b][color= grey][size=24]External Links[/size][/color][/b]

-[b]Third-Party Themes[/b]

-

+[h2]External resource links[/h2]

+[h3]Third-Party Themes[/h3]

+[ul]

 [*][url=https://github.com/omigeot/redstrap3]Redstrap[/url]

 [*][url=https://bitbucket.org/tobiasd/red-clean]Clean[/url]

 [*][url=https://github.com/tonybaldwin/redmatrixthemes/]nubasic[/url]

 [*][url=https://github.com/deadsuperhero/redmatrix-themes]Sean Tilley's themes[/url]

-

-[b]Third-Party Addons[/b]

+[/ul]

+[h3]Third-Party addons[/h3]

+[ul]

 [*][url=https://abcentric.net/git/abcjsplugin.git]ABCjs integration - display scores in posts (WIP)[/url]

-[b]Related Projects[/b]

-

+[/ul]

+[h3]Related projects[/h3]

+[ul]

 [*][url=https://addons.mozilla.org/en-US/firefox/addon/redshare/]Redshare for Firefox[/url]

 [*][url=https://github.com/cvogeley/red-for-android]Red for Android[/url]

 [*][url=https://github.com/zzottel/feed2red]feed2red.pl (posts Atom/RSS feeds to channel)[/url]

 [*][url=https://wordpress.org/plugins/hubzilla-wp/]WordPress gateway (combine with wppost addon for full features)[/url]

+[/ul]

 

 #include doc/macros/main_footer.bb;

diff --git a/doc/general.bb b/doc/general.bb
index c9c2501e5..bbc85c900 100644
--- a/doc/general.bb
+++ b/doc/general.bb
@@ -1,20 +1,16 @@
-
-[h2]Project/Site Information[/h2]
-
+[h2]Project and site information[/h2]
+[h3]$Projectname[/h3]
 [zrl=[baseurl]/help/Privacy]Privacy Policy[/zrl]
-
 [zrl=[baseurl]/help/history]$Projectname history[/zrl]
-
-[h3]External Resources[/h3]
-[zrl=[baseurl]/help/external-resource-links]External Resource Links[/zrl]
-
+[h3]External resources[/h3]
+[zrl=[baseurl]/help/external-resource-links]List of external resources[/zrl]
 [url=https://github.com/redmatrix/hubzilla]Main Website[/url]
 [url=https://github.com/redmatrix/hubzilla-addons]Addon Website[/url]
-
 [url=[baseurl]/help/credits]$Projectname Credits[/url]
-
-[h3]About This $Projectname Hub[/h3]
+[h3]About this $Projectname hub[/h3]
 [zrl=[baseurl]/help/TermsOfService]Terms of Service For This Hub[/zrl]
 [zrl=[baseurl]/siteinfo]Hub Information (/siteinfo)[/zrl]
 [zrl=[baseurl]/siteinfo/json]Detailed Technical Hub Information in JSON format(/siteinfo/json)[/zrl]
 
+#include doc/macros/main_footer.bb;
+
diff --git a/doc/members.bb b/doc/members.bb
index 13339ef2d..bf5b09898 100644
--- a/doc/members.bb
+++ b/doc/members.bb
@@ -1,6 +1,5 @@
-[h2]Documentation for Hub Members[/h2]
-
-[h3]Getting Started[/h3]
+[h2]Documentation for hub members[/h2]
+[h3]Getting started[/h3]
 [zrl=[baseurl]/help/registration]Account Registration[/zrl]
 [zrl=[baseurl]/help/accounts_profiles_channels_basics]You at $Projectname: accounts, profiles and channels in short[/zrl]
 [zrl=[baseurl]/help/profiles]Profiles[/zrl]
@@ -11,8 +10,7 @@
 [zrl=[baseurl]/help/permissions]Permissions And Encryption: You Are In Control[/zrl]
 [zrl=[baseurl]/help/cloud]Cloud Storage[/zrl]
 [zrl=[baseurl]/help/remove_account]Remove Channel or Account[/zrl]
-
-[h3]Members Help[/h3]
+[h3]Members help[/h3]
 [zrl=[baseurl]/help/tags_and_mentions]Tags and Mentions[/zrl]
 [zrl=[baseurl]/help/webpages]Web Pages[/zrl]
 [zrl=[baseurl]/help/bbcode]BBcode reference for posts and comments[/zrl]
@@ -23,3 +21,5 @@
 [zrl=[baseurl]/help/diaspora_compat]Diaspora Communications Compatibility (Diaspora and Friendica)[/zrl]
 [zrl=[baseurl]/help/faq_members]FAQ For Members[/zrl]
 [zrl=[baseurl]/help/bugs]Bugs, Issues, and things that go bump in the night...[/zrl]
+
+#include doc/macros/main_footer.bb;
diff --git a/doc/troubleshooting.bb b/doc/troubleshooting.bb
index 1a2bd7f12..023d3c8b1 100644
--- a/doc/troubleshooting.bb
+++ b/doc/troubleshooting.bb
@@ -1,6 +1,4 @@
-[b]Troubleshooting[/b]

-

-[li][zrl=[baseurl]/help/problems-following-an-update]Problems following an update[/zrl][/li]

+[h2]Troubleshooting[/h2]

 

 When reporting issues, please try to provide as much detail as may be necessary for developers to reproduce the issue and provide the complete text of all error messages.

 

@@ -13,9 +11,12 @@ In the case of "500" errors, the issues may often be logged in your webserver lo
 

 We encourage you to try to the best of your abilities to use these logs combined with the source code in your possession to troubleshoot issues and find their cause. The community is often able to help, but only you have access to your site logfiles and it is considered a security risk to share them.   

 

-

 If a code issue has been uncovered, please report it on the project bugtracker (https://github.com/redmatrix/hubzilla/issues). Again provide as much detail as possible to avoid us going back and forth asking questions about your configuration or how to duplicate the problem, so that we can get right to the problem and figure out what to do about it. You are also welcome to offer your own solutions and submit patches. In fact we encourage this as we are all volunteers and have little spare time available. The more people that help, the easier the workload for everybody. It's OK if your solution isn't perfect. Every little bit helps and perhaps we can improve on it.  

 

-#include doc/macros/troubleshooting_footer.bb;

+[h3]Troubleshooting updates[/h3]

+[ul]

+[li][zrl=[baseurl]/help/problems-following-an-update]Problems following an update[/zrl][/li]

+[/ul]

+

 #include doc/macros/main_footer.bb;