Merge pull request #176 from acquia-pso/DEG-172

DEG-172: Error message corrected and updated doc.

docs/build/html/_sources/installation.rst.txt

@@ -39,15 +39,17 @@ Create a Google spreadsheet for defining all drupal entities like  `DEG sample t
 
 Configure DEG on Drupal
 ------------------------
+
+.. Important::
+   * **Private file system** should be configured before configuring DEG.
+   * To configure **Private file system**, refer **Private file path** section in `settings.php` file to configure it.
+
 * Login as Administrator on site
 * Go to menu Configuration -> Development -> Drupal Spec tool: Entity Generate -> Google Sheet API (/admin/config/dst_entity_generate/settings/google_sheet_api)
 * And follow the steps for configuration fo Google spreadsheet in DEG tool.
 * Finally, It will redirect to General Settings (/admin/config/dst_entity_generate/settings) where we can enable the entity types.
 
-
-.. Important::
-
-   * **Private** file directory should be configured in Drupal.
+.. Note::
    * See **Recent log messages** of Drupal if any errors occur.
 
 

docs/build/html/installation.html

@@ -197,16 +197,22 @@ <h2>Download using composer<a class="headerlink" href="#download-using-composer"
 </div>
 <div class="section" id="configure-deg-on-drupal">
 <h2>Configure DEG on Drupal<a class="headerlink" href="#configure-deg-on-drupal" title="Permalink to this headline">¶</a></h2>
+<div class="admonition important">
+<p class="admonition-title">Important</p>
+<ul class="simple">
+<li><p><strong>Private file system</strong> should be configured before configuring DEG.</p></li>
+<li><p>To configure <strong>Private file system</strong>, refer <strong>Private file path</strong> section in <cite>settings.php</cite> file to configure it.</p></li>
+</ul>
+</div>
 <ul class="simple">
 <li><p>Login as Administrator on site</p></li>
 <li><p>Go to menu Configuration -&gt; Development -&gt; Drupal Spec tool: Entity Generate -&gt; Google Sheet API (/admin/config/dst_entity_generate/settings/google_sheet_api)</p></li>
 <li><p>And follow the steps for configuration fo Google spreadsheet in DEG tool.</p></li>
 <li><p>Finally, It will redirect to General Settings (/admin/config/dst_entity_generate/settings) where we can enable the entity types.</p></li>
 </ul>
-<div class="admonition important">
-<p class="admonition-title">Important</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
 <ul class="simple">
-<li><p><strong>Private</strong> file directory should be configured in Drupal.</p></li>
 <li><p>See <strong>Recent log messages</strong> of Drupal if any errors occur.</p></li>
 </ul>
 </div>

docs/source/installation.rst

@@ -39,15 +39,17 @@ Create a Google spreadsheet for defining all drupal entities like  `DEG sample t
 
 Configure DEG on Drupal
 ------------------------
+
+.. Important::
+   * **Private file system** should be configured before configuring DEG.
+   * To configure **Private file system**, refer **Private file path** section in `settings.php` file to configure it.
+
 * Login as Administrator on site
 * Go to menu Configuration -> Development -> Drupal Spec tool: Entity Generate -> Google Sheet API (/admin/config/dst_entity_generate/settings/google_sheet_api)
 * And follow the steps for configuration fo Google spreadsheet in DEG tool.
 * Finally, It will redirect to General Settings (/admin/config/dst_entity_generate/settings) where we can enable the entity types.
 
-
-.. Important::
-
-   * **Private** file directory should be configured in Drupal.
+.. Note::
    * See **Recent log messages** of Drupal if any errors occur.
 
 

src/Form/GoogleSheetApiSetting.php

@@ -108,7 +108,7 @@ public function buildForm(array $form, FormStateInterface $form_state) {
     if (empty($file_private_path)) {
       $form['private_directory_message'] = [
         '#type' => 'item',
-        '#markup' => '<div class="messages messages--error"><b>' . $this->t('Please configure private file path.') . '</b></div>',
+        '#markup' => '<div class="messages messages--error"><b>' . $this->t('Private file system is not configured. Refer "Private file path" section in settings.php file to configure it.') . '</b></div>',
       ];
     }