add help for configuration and repositories

scm-ui-components/packages/ui-components/src/forms/AddEntryToTableField.js

@@ -3,7 +3,6 @@ import React from "react";
 
 import { AddButton } from "../buttons";
 import InputField from "./InputField";
-import { translate } from "react-i18next";
 
 type Props = {
   addEntry: string => void,
@@ -11,7 +10,7 @@ type Props = {
   buttonLabel: string,
   fieldLabel: string,
   errorMessage: string,
-  t: string => string,
+  helpText?: string
 };
 
 type State = {
@@ -27,7 +26,7 @@ class AddEntryToTableField extends React.Component<Props, State> {
   }
 
   render() {
-    const { disabled, buttonLabel, fieldLabel, errorMessage, t } = this.props;
+    const { disabled, buttonLabel, fieldLabel, errorMessage, helpText} = this.props;
     return (
       <div className="field">
         <InputField
@@ -38,7 +37,7 @@ class AddEntryToTableField extends React.Component<Props, State> {
           value={this.state.entryToAdd}
           onReturnPressed={this.appendEntry}
           disabled={disabled}
-          helpText={t("group-form.help.membersHelpText")}
+          helpText={helpText}
         />
         <AddButton
           label={buttonLabel}
@@ -68,4 +67,4 @@ class AddEntryToTableField extends React.Component<Props, State> {
   };
 }
 
-export default translate("groups")(AddEntryToTableField);
+export default AddEntryToTableField;

scm-ui/public/locales/en/config.json

@@ -64,5 +64,27 @@
     "login-attempt-limit-timeout-invalid": "This is not a number",
     "login-attempt-limit-invalid": "This is not a number",
     "plugin-url-invalid": "This is not a valid url"
+  },
+  "help": {
+    "realmDescriptionHelpText": "Enter authentication realm description",
+    "dateFormatHelpText": "Moments date format. Please have a look at \n <a href=`http://momentjs.com/docs/#/displaying/format/` target=`_blank`>http://momentjs.com/docs/#/displaying/format/</a>.<br />\n<b>Note:</b><br />\n {0} - is replaced by a `time ago` string (e.g. 2 hours ago).",
+    "pluginRepositoryHelpText": "The url of the plugin repository.<br />Explanation of the {placeholders}:\n <br /><b>version</b> = SCM-Manager Version<br /><b>os</b> = Operation System<br /><b>arch</b> = Architecture",
+    "enableForwardingHelpText": "Enbale mod_proxy port forwarding.",
+    "enableRepositoryArchiveHelpText": "Enable repository archives. A complete page reload is required after a change of this value.",
+    "disableGroupingGridHelpText": "Disable repository Groups. A complete page reload is required after a change of this value.",
+    "allowAnonymousAccessHelpText": "Anonymous users have read access on public repositories.",
+    "skipFailedAuthenticatorsHelpText": "Do not stop the authentication chain, \n if an authenticator finds the user but fails to authenticate the user.",
+    "adminGroupsHelpText": "Names of groups with admin permissions.",
+    "adminUsersHelpText": "Names of users with admin permissions.",
+    "forceBaseUrlHelpText": "Redirects to the base url if the request comes from a other url",
+    "baseUrlHelpText": "The url of the application (with context path) i.e. http://localhost:8080/scm",
+    "loginAttemptLimitHelpText": "Maximum allowed login attempts. Use -1 to disable the login attempt limit.",
+    "loginAttemptLimitTimeoutHelpText": "Timeout in seconds for users which are temporary disabled,\n because of too many failed login attempts.",
+    "enableProxyHelpText": "Enable Proxy",
+    "proxyPortHelpText": "The proxy port",
+    "proxyPasswordHelpText": "The password for the proxy server authentication.",
+    "proxyServerHelpText": "The proxy server",
+    "proxyUserHelpText": "The username for the proxy server authentication.",
+    "proxyExcludesHelpText": "A comma separated list of glob patterns for hostnames which should be excluded from proxy settings."
   }
 }

scm-ui/public/locales/en/repos.json

@@ -42,5 +42,11 @@
       "submit": "Yes",
       "cancel": "No"
     }
+  },
+  "help": {
+    "nameHelpText": "The name of the repository. This name will be part of the repository url.",
+    "typeHelpText": "The type of the repository (e.g. Mercurial, Git or Subversion).",
+    "contactHelpText": "Email address of the person who is responsible for this repository.",
+    "descriptionHelpText": "A short description of the repository."
   }
 }

scm-ui/src/config/components/form/AdminSettings.js

@@ -33,6 +33,7 @@ class AdminSettings extends React.Component<Props> {
           buttonLabel={t("admin-settings.add-group-button")}
           fieldLabel={t("admin-settings.add-group-textfield")}
           errorMessage={t("admin-settings.add-group-error")}
+          helpText={t("help.adminGroupsHelpText")}
         />
         <AdminUserTable
           adminUsers={adminUsers}
@@ -47,6 +48,7 @@ class AdminSettings extends React.Component<Props> {
           buttonLabel={t("admin-settings.add-user-button")}
           fieldLabel={t("admin-settings.add-user-textfield")}
           errorMessage={t("admin-settings.add-user-error")}
+          helpText={t("help.adminUsersHelpText")}
         />
       </div>
     );

scm-ui/src/config/components/form/BaseUrlSettings.js

@@ -23,12 +23,14 @@ class BaseUrlSettings extends React.Component<Props> {
           label={t("base-url-settings.force-base-url")}
           onChange={this.handleForceBaseUrlChange}
           disabled={!hasUpdatePermission}
+          helpText={t("help.forceBaseUrlHelpText")}
         />
         <InputField
           label={t("base-url-settings.base-url")}
           onChange={this.handleBaseUrlChange}
           value={baseUrl}
           disabled={!hasUpdatePermission}
+          helpText={t("help.baseUrlHelpText")}
         />
       </div>
     );

scm-ui/src/config/components/form/GeneralSettings.js

@@ -41,19 +41,21 @@ class GeneralSettings extends React.Component<Props> {
           onChange={this.handleRealmDescriptionChange}
           value={realmDescription}
           disabled={!hasUpdatePermission}
-          helpText={"hallo"}
+          helpText={t("help.realmDescriptionHelpText")}
         />
         <InputField
           label={t("general-settings.date-format")}
           onChange={this.handleDateFormatChange}
           value={dateFormat}
           disabled={!hasUpdatePermission}
+          helpText={t("help.dateFormatHelpText")}
         />
         <InputField
           label={t("general-settings.plugin-url")}
           onChange={this.handlePluginUrlChange}
           value={pluginUrl}
           disabled={!hasUpdatePermission}
+          helpText={t("help.pluginRepositoryHelpText")}
         />
         <InputField
           label={t("general-settings.default-namespace-strategy")}
@@ -66,31 +68,35 @@ class GeneralSettings extends React.Component<Props> {
           label={t("general-settings.enabled-xsrf-protection")}
           onChange={this.handleEnabledXsrfProtectionChange}
           disabled={!hasUpdatePermission}
-          helpText={"hey"}
+          helpText={t("help.enableXsrfProtectionHelpText")}
         />
         <Checkbox
           checked={enableRepositoryArchive}
           label={t("general-settings.enable-repository-archive")}
           onChange={this.handleEnableRepositoryArchiveChange}
           disabled={!hasUpdatePermission}
+          helpText={t("help.enableRepositoryArchiveHelpText")}
         />
         <Checkbox
           checked={disableGroupingGrid}
           label={t("general-settings.disable-grouping-grid")}
           onChange={this.handleDisableGroupingGridChange}
           disabled={!hasUpdatePermission}
+          helpText={t("help.disableGroupingGridHelpText")}
         />
         <Checkbox
           checked={anonymousAccessEnabled}
           label={t("general-settings.anonymous-access-enabled")}
           onChange={this.handleAnonymousAccessEnabledChange}
           disabled={!hasUpdatePermission}
+          helpText={t("help.allowAnonymousAccessHelpText")}
         />
         <Checkbox
           checked={skipFailedAuthenticators}
           label={t("general-settings.skip-failed-authenticators")}
           onChange={this.handleSkipFailedAuthenticatorsChange}
           disabled={!hasUpdatePermission}
+          helpText={t("help.skipFailedAuthenticatorsHelpText")}
         />
       </div>
     );

scm-ui/src/config/components/form/LoginAttempt.js

@@ -47,6 +47,7 @@ class LoginAttempt extends React.Component<Props, State> {
           disabled={!hasUpdatePermission}
           validationError={this.state.loginAttemptLimitError}
           errorMessage={t("validation.login-attempt-limit-invalid")}
+          helpText={t("help.loginAttemptLimitHelpText")}
         />
         <InputField
           label={t("login-attempt.login-attempt-limit-timeout")}
@@ -55,6 +56,7 @@ class LoginAttempt extends React.Component<Props, State> {
           disabled={!hasUpdatePermission}
           validationError={this.state.loginAttemptLimitTimeoutError}
           errorMessage={t("validation.login-attempt-limit-timeout-invalid")}
+          helpText={t("help.loginAttemptLimitTimeoutHelpText")}
         />
       </div>
     );

scm-ui/src/config/components/form/ProxySettings.js

@@ -42,6 +42,7 @@ class ProxySettings extends React.Component<Props> {
           label={t("proxy-settings.enable-proxy")}
           onChange={this.handleEnableProxyChange}
           disabled={!hasUpdatePermission}
+          helpText={t("help.enableProxyHelpText")}
         />
         <InputField
           label={t("proxy-settings.proxy-password")}
@@ -49,24 +50,28 @@ class ProxySettings extends React.Component<Props> {
           value={proxyPassword}
           type="password"
           disabled={!enableProxy || !hasUpdatePermission}
+          helpText={t("help.proxyPasswordHelpText")}
         />
         <InputField
           label={t("proxy-settings.proxy-port")}
           value={proxyPort}
           onChange={this.handleProxyPortChange}
           disabled={!enableProxy || !hasUpdatePermission}
+          helpText={t("help.proxyPortHelpText")}
         />
         <InputField
           label={t("proxy-settings.proxy-server")}
           value={proxyServer}
           onChange={this.handleProxyServerChange}
           disabled={!enableProxy || !hasUpdatePermission}
+          helpText={t("help.proxyServerHelpText")}
         />
         <InputField
           label={t("proxy-settings.proxy-user")}
           value={proxyUser}
           onChange={this.handleProxyUserChange}
           disabled={!enableProxy || !hasUpdatePermission}
+          helpText={t("help.proxyUserHelpText")}
         />
         <ProxyExcludesTable
           proxyExcludes={proxyExcludes}
@@ -81,6 +86,7 @@ class ProxySettings extends React.Component<Props> {
           buttonLabel={t("proxy-settings.add-proxy-exclude-button")}
           fieldLabel={t("proxy-settings.add-proxy-exclude-textfield")}
           errorMessage={t("proxy-settings.add-proxy-exclude-error")}
+          helpText={t("help.proxyExcludesHelpText")}
         />
       </div>
     );

scm-ui/src/groups/components/GroupForm.js

@@ -106,6 +106,7 @@ class GroupForm extends React.Component<Props, State> {
           buttonLabel={t("add-member-button.label")}
           fieldLabel={t("add-member-textfield.label")}
           errorMessage={t("add-member-textfield.error")}
+          helpText={t("group-form.help.membersHelpText")}
         />
         <SubmitButton
           disabled={!this.isValid()}

scm-ui/src/repos/components/form/RepositoryForm.js

@@ -90,12 +90,14 @@ class RepositoryForm extends React.Component<Props, State> {
           value={repository ? repository.contact : ""}
           validationError={this.state.contactValidationError}
           errorMessage={t("validation.contact-invalid")}
+          helpText={t("help.contactHelpText")}
         />
 
         <Textarea
           label={t("repository.description")}
           onChange={this.handleDescriptionChange}
           value={repository ? repository.description : ""}
+          helpText={t("help.descriptionHelpText")}
         />
         <SubmitButton
           disabled={!this.isValid()}
@@ -129,12 +131,14 @@ class RepositoryForm extends React.Component<Props, State> {
           value={repository ? repository.name : ""}
           validationError={this.state.nameValidationError}
           errorMessage={t("validation.name-invalid")}
+          helpText={t("help.nameHelpText")}
         />
         <Select
           label={t("repository.type")}
           onChange={this.handleTypeChange}
           value={repository ? repository.type : ""}
           options={this.createSelectOptions(repositoryTypes)}
+          helpText={t("help.typeHelpText")}
         />
       </div>
     );