edited data dictionary description (#3781)

* edited data dictionary description * Update docs/data_dictionaries/index.rst Co-authored-by: E. Belfer <[email protected]> * Update docs/data_dictionaries/index.rst Co-authored-by: E. Belfer <[email protected]> * Update docs/data_dictionaries/index.rst Co-authored-by: E. Belfer <[email protected]> * removed rst from gitignore file * resolved the issues * edited docs * edited the data dictionary docs --------- Co-authored-by: Zane Selvans <[email protected]> Co-authored-by: E. Belfer <[email protected]> Co-authored-by: Austen Sharpe <[email protected]>
catalyst-cooperative · Sep 5, 2024 · 3bce7e5 · 3bce7e5
1 parent 7ac304f
commit 3bce7e5
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 4 deletions.
diff --git a/docs/data_dictionaries/ferc1_db.rst b/docs/data_dictionaries/ferc1_db.rst
@@ -1,5 +1,5 @@
 ===============================================================================
-FERC Form 1 Data Dictionary
+Raw FERC Form 1 Data Dictionary
 ===============================================================================
 
 We have mapped the Visual FoxPro DBF files to their corresponding FERC Form 1

diff --git a/docs/data_dictionaries/index.rst b/docs/data_dictionaries/index.rst
@@ -3,20 +3,42 @@
 Data Dictionaries
 =================
 
+Data Processed & Cleaned by PUDL
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+The PUDL data dictionary provides detailed metadata for the tables
+in the PUDL database. This includes table descriptions,
+field names, field descriptions, and field datatypes.
+
 .. toctree::
-   :caption: Data Processed & Cleaned by PUDL
    :maxdepth: 1
+   :titlesonly:
 
    pudl_db
 
+Raw, Unprocessed Data
+^^^^^^^^^^^^^^^^^^^^^
+Certain raw datasets (e.g. FERC Form 1) require additional effort to process.
+We load these raw sources into SQLite databases before feeding them into
+the PUDL data pipeline. The dictionaries below provide key metadata on
+these raw sources including table name, table
+description, links to corresponding database tables,
+raw file names, page numbers, and data reporting frequency.
+
 .. toctree::
-   :caption: Raw, Unprocessed Data
    :maxdepth: 1
+   :titlesonly:
 
    ferc1_db
 
+Code Descriptions & Metadata
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+This section contains mappings of codes in the raw tables to their
+corresponding labels and descriptions in the processed PUDL database tables.
+For example, the code, NV, represents the full description "Never to exceed"
+in the core_eia_codes_averaging_periods table.
+
 .. toctree::
-   :caption: Code Descriptions & Metadata
    :maxdepth: 1
+   :titlesonly:
 
    codes_and_labels