documentation rewrite

Author: Daniel-Nashed

docs/index.md

@@ -8,17 +8,16 @@ has_children: true
 
 # Introduction
 
-The Domino cross platform start/stop and diagnostic script has been written
-to unify and simplify running Domino on Linux and UNIX. The start script
-is designed to be "one-stop shopping" for all kind of operations done on the
-Linux/UNIX prompt. The script can start and stop the server, provides an interactive
-console and run NSD in different flavors.
+[The Domino cross platform start/stop and diagnostic script](https://github.com/nashcom/domino-startscript)
+has been designed to unify and simplify running Domino on Linux and UNIX.
+The start script is designed to be "one-stop shopping" for all kind of operations performed on the Linux/UNIX prompt. 
+The script can start and stop the server, provides an interactive console and run NSD in different flavors.
 It ensures that the environment is always setup correct and supports multiple partitions.
 
 This script is designed to run with a dedicated user for each partition.
-Out of the box the script is configured to use the "notes" user/group and the standard
-directories for binaries (`/opt/hcl/domino`) and the data directory (`/local/notesdata`).
-You should setup all settings in the script configuration file (`/etc/sysconfig/rc_domino_config`).
+It is already configured for the default user "notes" user and group (notes:notes).
+Binary are assumed to be in`/opt/hcl/domino`, the data directory is assumed in `/local/notesdata`.
+Settings are configured in `/etc/sysconfig/rc_domino_config`.
 
 ## Systemd
 

docs/startscript/parameters.md

@@ -7,7 +7,7 @@ parent: "Domino Start Script"
 has_children: false
 ---
 
-# Configuration Parameters
+# Required Configuration Parameters
 
 Parameters are specified in the configuration file `/etc/sysconfig/rc_domino_config`.  
 The configuration shipped with the start script comes with reasonable defaults.  
@@ -32,6 +32,8 @@ Default: `/local/notesdata`
 
 Configuration variable. Needs to be set to `yes` per user to confirm that the environment for this user is setup correctly.
 
+# Configuration Parameters
+
 ## DOMINO_LANG
 
 Language setting used to determine local settings
@@ -147,12 +149,6 @@ Enable this option (DOMINO_RESET_LOADMON=`yes`) to remove loadmon.ncf at server
 Note: When using this option you will only see a loadmon.ncf in the data directory,
 when the server is down, because it will be only written at server shutdown time.
 
-## DOMINO_CUSTOM_COMMAND_BASEPATH (expert)
-
-This option allows you to specify a directory which is used for custom commands.  
-If a command which is specified when invoking the script matches a script name which is present in the specified directory (and if the script can be executed) the custom command will execute the script passing all current parameters of the current command.  
-This is a new flexible way to plug-in your own commands without changing the code of the main script logic.
-
 ## DOMINO_NSD_BEFORE_KILL (default)
 
 Generates a NSD before finally using NSD -kill to recycle the server.
@@ -178,38 +174,6 @@ In such cases you have to move those files before restarting the server Server-R
 
 Therefore the script only deletes *TMP files in data directory which are at least 1 day old.
 
-## DOMINO_CUSTOM_REMOVE_TEMPFILES_SCRIPT (expert)
-
-This script allows a customizable way to remove temp files on server start.  
-A sample script `remove_tempfiles_script` is included. The script works in combination with `DOMINO_REMOVE_TEMPFILES`.
-You have to specify a script name and enable the option. This script overwrites the default code in the start script.
-
-## DOMINO_CLEAR_LOGS_STARTUP (expert)
-
-Clear Logs on startup before the server starts. See `clearlog` for details about the actions performed.
-
-## DOMINO_LOG_CLEAR_DAYS (expert)
-
-Number of days until logs are cleared (See details in `clearlog` command description).
-
-## DOMINO_LOG_BACKUP_CLEAR_DAYS (expert)
-
-Number of days until backup logs are cleared (See details in `clearlog` command description).
-
-## DOMINO_CUSTOM_LOG_CLEAR_PATH (expert)
-
-Specify this custom location to remove old logs from a directory.  
-Can only be used in combination with `DOMINO_CUSTOM_LOG_CLEAR_DAYS`
-
-## DOMINO_CUSTOM_LOG_CLEAR_DAYS (expert)
-
-Age of log files to be cleared. Works in combination with `DOMINO_CUSTOM_LOG_CLEAR_PATH`.
-
-## DOMINO_CUSTOM_LOG_CLEAR_SCRIPT (expert)
-
-Custom log clear script will be used instead of the standard log clear operations and replaces all other clear operations!
-(See details in `clearlog` command description).
-
 ## DOMINO_LOG_DB_DAYS
 
 Rename log.nsf database on startup after n days (This will only work for the default log.nsf location and not check the log= notes.ini parameter).
@@ -287,17 +251,6 @@ The following settings are intended to add functionality to the existing start s
 Those scripts inherit all current variables of the main script. The scripts are invoked as kind of call-back functionality.
 You have to ensure that those scripts terminate in time.
 
-## DOMINO_3RD_PARTY_BIN_DIRS
-
-3rd Party directories to check for running processes when cleaning up server resources specify separate directories with blank in-between. directory names should not contain blanks.  
-Those directories are also checked for running processes when cleaning up server resources via `clenup` command by default only the $LOTUS directory is checked for running binaries.
-
-## DOMINO_SCRIPT_DIR (expert)
-
-This variable can be used to specify a directory for all scripts that can be invoked.  
-It is only referenced in the configuration file and used by default for a scripts which are invoked.  
-But you can also specify different locations per pre/post script.
-
 ## DOMINO_TIKA_SHUTDOWN_TERM_SECONDS
 
 Tries to shutdown the Tika index server during shutdown.  
@@ -316,43 +269,10 @@ Shutdown Delay for delayed shutdown command.
 
 Default is **20 seconds** if script is defined.
 
-## DOMINO_PRE_STARTUP_SCRIPT (expert)
-
-This script is invoked before starting the server.
-
-## DOMINO_POST_STARTUP_SCRIPT (expert)
-
-This script is invoked after starting the server.
-
-## DOMINO_PRE_SHUTDOWN_SCRIPT (expert)
-
-This script is invoked before shutting down the server.
-
-## DOMINO_POST_SHUTDOWN_SCRIPT (expert)
-
-This script is invoked after shutting down the server.
-
-## DOMINO_PRE_KILL_SCRIPT (expert)
-
-This script is invoked before any `nsd -kill` is executed.
-
-## DOMINO_POST_KILL_SCRIPT (expert)
-
-This script is invoked after any `nsd -kill` is executed.
-
-## DOMINO_PRE_CLEANUP_SCRIPT (expert)
-
-This script is invoked before cleaning up server resources native on OS level.
-
-## DOMINO_POST_CLEANUP_SCRIPT (expert)
-
-This script is invoked after cleaning up server resources native on OS level.
-
-## DOMINO_PRE_STATUS_SCRIPT (expert)
+## DOMINO_3RD_PARTY_BIN_DIRS
 
-Script which will be executed before the server status is checked.  
-This can be helpful in case you want to check status for other tools like monitoring tools before you check the Domino server status.  
-The option does not directly impact the status of the Domino status and is mainly intended to add log output.
+3rd Party directories to check for running processes when cleaning up server resources specify separate directories with blank in-between. directory names should not contain blanks.  
+Those directories are also checked for running processes when cleaning up server resources via `clenup` command by default only the $LOTUS directory is checked for running binaries.
 
 ## DOMINO_START_COMPACT_OPTIONS
 
@@ -396,6 +316,94 @@ Log compact options.
 
 Start log compact options.
 
+
+# Expert Configuration Parameters
+
+The following configuration parameters are intended for experienced administrors only.
+
+## DOMINO_CUSTOM_COMMAND_BASEPATH (expert)
+
+This option allows you to specify a directory which is used for custom commands.  
+If a command which is specified when invoking the script matches a script name which is present in the specified directory (and if the script can be executed) the custom command will execute the script passing all current parameters of the current command.  
+This is a new flexible way to plug-in your own commands without changing the code of the main script logic.
+
+## DOMINO_CUSTOM_REMOVE_TEMPFILES_SCRIPT (expert)
+
+This script allows a customizable way to remove temp files on server start.  
+A sample script `remove_tempfiles_script` is included. The script works in combination with `DOMINO_REMOVE_TEMPFILES`.
+You have to specify a script name and enable the option. This script overwrites the default code in the start script.
+
+## DOMINO_CLEAR_LOGS_STARTUP (expert)
+
+Clear Logs on startup before the server starts. See `clearlog` for details about the actions performed.
+
+## DOMINO_LOG_CLEAR_DAYS (expert)
+
+Number of days until logs are cleared (See details in `clearlog` command description).
+
+## DOMINO_LOG_BACKUP_CLEAR_DAYS (expert)
+
+Number of days until backup logs are cleared (See details in `clearlog` command description).
+
+## DOMINO_CUSTOM_LOG_CLEAR_PATH (expert)
+
+Specify this custom location to remove old logs from a directory.  
+Can only be used in combination with `DOMINO_CUSTOM_LOG_CLEAR_DAYS`
+
+## DOMINO_CUSTOM_LOG_CLEAR_DAYS (expert)
+
+Age of log files to be cleared. Works in combination with `DOMINO_CUSTOM_LOG_CLEAR_PATH`.
+
+## DOMINO_CUSTOM_LOG_CLEAR_SCRIPT (expert)
+
+Custom log clear script will be used instead of the standard log clear operations and replaces all other clear operations!
+(See details in `clearlog` command description).
+
+
+## DOMINO_SCRIPT_DIR (expert)
+
+This variable can be used to specify a directory for all scripts that can be invoked.  
+It is only referenced in the configuration file and used by default for a scripts which are invoked.  
+But you can also specify different locations per pre/post script.
+
+## DOMINO_PRE_STARTUP_SCRIPT (expert)
+
+This script is invoked before starting the server.
+
+## DOMINO_POST_STARTUP_SCRIPT (expert)
+
+This script is invoked after starting the server.
+
+## DOMINO_PRE_SHUTDOWN_SCRIPT (expert)
+
+This script is invoked before shutting down the server.
+
+## DOMINO_POST_SHUTDOWN_SCRIPT (expert)
+
+This script is invoked after shutting down the server.
+
+## DOMINO_PRE_KILL_SCRIPT (expert)
+
+This script is invoked before any `nsd -kill` is executed.
+
+## DOMINO_POST_KILL_SCRIPT (expert)
+
+This script is invoked after any `nsd -kill` is executed.
+
+## DOMINO_PRE_CLEANUP_SCRIPT (expert)
+
+This script is invoked before cleaning up server resources native on OS level.
+
+## DOMINO_POST_CLEANUP_SCRIPT (expert)
+
+This script is invoked after cleaning up server resources native on OS level.
+
+## DOMINO_PRE_STATUS_SCRIPT (expert)
+
+Script which will be executed before the server status is checked.  
+This can be helpful in case you want to check status for other tools like monitoring tools before you check the Domino server status.  
+The option does not directly impact the status of the Domino status and is mainly intended to add log output.
+
 ## DOMINO_CONSOLE_SERVERC (expert)
 
 By default live console uses `server -c "cmd"` to run server commands.