Bläddra i källkod

Added new docs for file management. Issue #772

Stephen Ficklin 6 år sedan
förälder
incheckning
e71d4a111e

+ 3 - 2
docs/dev_guide/exporting_field_settings.rst

@@ -74,18 +74,19 @@ You can verify your new field is enabled and working by creating a new Analysis
 
 
 Exporting the bundle field displays
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Once we are happy with our bundle field configuration, we can export the display settings using the Drupal Features module.
 
 First, we enable the Features module using drush: ``drush pm-enable features -y``.  This adds a Features area under **Admin -> Structure**.  Navigate there and choose **Create Feature**.
 
 The field information we're looking for is in **Field Bases**, **Field Group**, and **Field Instances**.  We can search for FASTA to find the field base and instance, and "files" (the name of our group) to find the field group.
+
 .. note::
 
   Both **Field Bases** and **Field Instances** will contain the machine name of the field you want to export. **Field Bases** contains the site-wide information for a field and **Field Instances** contains the bundle-specific (i.e. Tripal Content Type) settings.
 
   **Field Group** will contain the machine name of the Tripal Pane and allows you to export the grouping settings you set on the **Manage Display Tab**.
+  
 I've also specified a custom path to keep all my Tripal features together under advanced options.
 
 

+ 1 - 0
docs/user_guide.rst

@@ -13,6 +13,7 @@ User's Guide
    user_guide/learn_chado
    user_guide/content_types
    user_guide/example_genomics
+   user_guide/file_management
    user_guide/mviews
    user_guide/searching
    user_guide/job_management

+ 1 - 1
docs/user_guide/example_genomics/func_annots/go.rst

@@ -1,2 +1,2 @@
 Managing Gene Ontology Annotations
-=================================
+==================================

+ 19 - 0
docs/user_guide/file_management.rst

@@ -0,0 +1,19 @@
+File Management
+===============
+
+User Quotas
+-----------
+Data importers that use the Tripal API and Tripal supported widgets automatically associate uploaded files with users. If you are allowing end-users to upload files you may want to consider adding quotas to prevent the server storage from filling.  To ensure that users do not exceed the limits of the server a quota system is available.  Navigate to **Administer > Tripal > File Management** and click the **User Quota** tab to reveal the following page:
+
+.. image:: ./file_management.user_quotas.1.png
+
+First, the total amount of space consumed by all uploaded files is shown at the top of the page.  Initially this will indicate 0 B (for zero bytes) as users upload files this value will change.  You may return to this page in the future to check how much space is currently used by user uploads. Here you can also specify the default system-wide quota that all users receive.  By default this is set to 64 Megabytes and an expiration of 60 days.  Once a file has existed on the site for 60 days the file is marked for deletion and will be removed when the Drupal cron is executed.  The default of 64MB per user is most likely too small for your site.  Adjust this setting and the days to expire as appropriate for your site's expected number of users and storage limitations and click the Save button to preserve any changes you have made.
+
+In addition to the default settings for all users, you may want to allow specific users to have a larger (or perhaps smaller) quota.  You can set user-specific quotas by clicking the **Add Custom User Quota** link near the bottom of the page.   The following page appears:
+
+.. image:: ./file_management.user_quotas.2.png
+
+
+Here you must specify the Drupal user name of the user who should be granted a custom quota.  This field will auto populate suggestions as you type to help you find the correct username.  Enter the desired quota size and expiration days and click the **Submit** button. you will then see the user-specific quota listed in the table at the bottom of the page:
+
+.. image:: ./file_management.user_quotas.3.png

BIN
docs/user_guide/file_management.user_quotas.1.png


BIN
docs/user_guide/file_management.user_quotas.2.png


BIN
docs/user_guide/file_management.user_quotas.3.png