Merge branch 'admindoc' into 'dev'

Improve admin documentation

See merge request hubzilla/core!1737

3 files changed, 36 insertions, 9 deletions

diff --git a/doc/database.bb b/doc/database.bb
index a72081e4a..a0c1e8841 100644
--- a/doc/database.bb
+++ b/doc/database.bb
@@ -1,3 +1,12 @@
+[h2]Database updates[/h2]
+
+In the [observer.baseurl]/admin/dbsync page the administrator can check if any update was not successful and, if so, retry it.
+
+If an update has failed but doesn't register as failed for some reason, the administrator can attempt to re-execute the update. For example for DB update #1999, by visiting the webpage:
+
+https://hubzilla.com.bradmin/dbsync/1999
+
+
 [h2]Database Tables[/h2][table border=1][tr][th]Table[/th][th]Description[/th][/tr]
 [tr][td][zrl=[baseurl]/help/database/db_abconfig]abconfig[/zrl][/td][td]arbitrary storage for connections of local channels[/td][/tr]
 [tr][td][zrl=[baseurl]/help/database/db_abook]abook[/zrl][/td][td]connections of local channels[/td][/tr]
diff --git a/doc/hidden_configs.bb b/doc/hidden_configs.bb
index dc3906df1..361aa94ba 100644
--- a/doc/hidden_configs.bb
+++ b/doc/hidden_configs.bb
@@ -1,7 +1,10 @@
 [h1]Advanced Configurations for Administrators[/h1]
-$Projectname contains many configuration options hidden from the main admin panel.
 
-These are generally options considered too niche, confusing, or advanced for the average member.  These settings can be activated from the the top level web directory with the syntax
+[i]This document assumes you're an administrator.[/i]
+
+$Projectname contains many configuration options hidden from the main admin panel. These are generally options considered too niche, advanced or prone do confusion.
+
+These settings can be modified through the shell, from the the top level web directory, with the syntax:
 
 [code]util/config cat key value[/code] 
 for a site configuration, or 
@@ -9,8 +12,13 @@ for a site configuration, or
 [code]util/pconfig channel_id cat key value[/code] 
 for a member configuration.
 
-This document assumes you're an administrator.
-[h2]pconfig[/h2][dl terms="mb"]
+For a site configuration, another option is to add a line to .htconfig.php, with the syntax:
+[code]App::$config['cat']['key'] = 'value';[/code]
+
+
+[h2]Member configuration (pconfig)[/h2]
+
+[dl terms="mb"]
   [*= system.always_my_theme ] Always use your own theme when viewing channels on the same hub.  This will break in some quite imaginative ways when viewing channels with  theme dependent Comanche.
   [*= system.blocked ] An array of xchans blocked by this channel.  Technically, this is a hidden config and does belong here, however, addons (notably  superblock) have made this available in the UI.
   [*= system.default_cipher ] Set the default cipher used for E2EE items.
@@ -31,7 +39,10 @@ Options are:
   [*= system.anonymous_comments ] By default or if set to 1, custom permissions can be set to allow anonymous (moderated) comments like WordPress, moderated by the channel owner. If set to 0, no member of your site can select or enable this. 
   [*= system.user_scalable ] Determine if the app is scalable on touch screens.  Defaults to on, to  disable, set to zero - real zero, not just false.
 [/dl]
-[h2]Site config[/h2][dl terms="mb"]
+
+[h2]Site configuration[/h2]
+
+[dl terms="mb"]
   [*= randprofile.check ] When requesting a random profile, check that it actually exists first
   [*= randprofile.retry ] Number of times to retry getting a random profile
   [*= system.admin_email ] Specifies the administrator's email for this site.  This is initially set during install.
@@ -87,13 +98,19 @@ Options are:
   [*= system.workflow_channel_next ] The page to direct new members to immediately after creating a channel.
   [*= system.workflow_register_next ] The page to direct members to immediately after creating an account (only when auto_channel_create or UNO is enabled).
 [/dl]
-[h2]Directory config[/h2]
-[h3]Directory search defaults[/h3][dl terms="mb"]
+
+
+[h3]Directory config[/h3]
+
+[h4]Directory search defaults[/h4]
+
+[dl terms="mb"]
   [*= directory.globaldir ] 0 or 1. Default 0.  If you visit the directory on a site you'll just see the members of that site by default. You have to go through an extra step to see the people in the rest of the network; and by doing so there's a clear delineation that these people *aren't* members of that site but of a larger network.
   [*= directory.pubforums ] 0 or 1. Public forums [i]should[/i] be default 0.
   [*= directory.safemode ] 0 or 1.  
 [/dl]
-[h3]Directory server configuration[/h3][i](see [zrl=[baseurl]/help/directories]help/directories[/zrl])[/i]
+
+[h4]Directory server configuration[/h4][i](see [zrl=[baseurl]/help/directories]help/directories[/zrl])[/i]
 
 [dl terms="mb"]
   [*= system.directory_mode ]
diff --git a/doc/toc.html b/doc/toc.html
index 9c3d22ab8..d2f2654a1 100644
--- a/doc/toc.html
+++ b/doc/toc.html
@@ -37,7 +37,8 @@
             <div class="flex-column">
                 <a class="nav-link" href="/help/admin/administrator_guide">Guide</a>
                 <a class="nav-link" href="/help/admin/hub_snapshots">Hub Snapshots</a>
-                <a class="nav-link" href="/help/database">Database Tables</a>
+                <a class="nav-link" href="/help/database">Database</a>
+                <a class="nav-link" href="/help/hidden_configs">Extra configs</a>
             </div>
         </div>
     </div>