docs - add pageinspect module landing page (#7407)

* docs - add pageinspect module landing page * remove peer scope * cannot inspect ao or external relations

docs - add pageinspect module landing page (#7407)
* docs - add pageinspect module landing page * remove peer scope * cannot inspect ao or external relations
9fa00ba7 · Lisa Owen · David Yozie · 3f111c5c · 9fa00ba7 · 9fa00ba7
3 changed file
--- a/gpdb-doc/dita/ref_guide/modules/intro.xml
+++ b/gpdb-doc/dita/ref_guide/modules/intro.xml
@@ -13,12 +13,12 @@
        modules are installed; refer to the linked module documentation for usage
        instructions.</p>
     <ul>
-       <li><codeph><xref href="citext.xml" scope="peer" format="dita"
+       <li><codeph><xref href="citext.xml" format="dita"
              >citext</xref></codeph> - Provides a case-insensitive, multibyte-aware text
          data type.</li>
-       <li><codeph><xref href="dblink.xml" scope="peer" format="dita"
+       <li><codeph><xref href="dblink.xml" format="dita"
              >dblink</xref></codeph> - Provides connections to other Greenplum databases.</li>
-       <li><codeph><xref href="fuzzystrmatch.xml" scope="peer"
+       <li><codeph><xref href="fuzzystrmatch.xml"
             format="dita">fuzzystrmatch</xref></codeph> - Determines similarities and differences
         between strings.</li>
       <li><codeph><xref
@@ -26,16 +26,16 @@
          format="html" scope="external">gp_sparse_vector</xref></codeph> - Implements
         a Greenplum Database data type that uses compressed storage of zeros to help
         with floating point calculations.</li>
-       <li><codeph><xref href="hstore.xml" scope="peer" format="dita"
+       <li><codeph><xref href="hstore.xml" format="dita"
             >hstore</xref></codeph> - Provides a data type for storing sets of key/value pairs
         within a single PostgreSQL value.</li>
-       <li><codeph><xref href="orafce_ref.xml" scope="peer" format="dita"
+       <li><codeph><xref href="orafce_ref.xml" format="dita"
             >orafce</xref></codeph> - Provides Greenplum Database-specific Oracle
          SQL compatibility functions.</li>
-       <li><codeph><xref href="https://www.postgresql.org/docs/9.4/pageinspect.html"
-             scope="external" format="html">pageinspect</xref></codeph> - Functions for low level
-         inspection of the contents of database pages; available to superusers only.</li>
-       <li><codeph><xref href="pgcrypto.xml" scope="peer" format="dita"
+       <li><codeph><xref href="pageinspect.xml" format="dita"
+             >pageinspect</xref></codeph> - Provides functions for low level inspection
+         of the contents of database pages; available to superusers only.</li>
+       <li><codeph><xref href="pgcrypto.xml" format="dita"
             >pgcrypto</xref></codeph> - Provides cryptographic functions for Greenplum
         Database.</li>
     </ul>

--- a/gpdb-doc/dita/ref_guide/modules/modules.ditamap
+++ b/gpdb-doc/dita/ref_guide/modules/modules.ditamap
@@ -8,7 +8,7 @@
    <topicref href="https://github.com/greenplum-db/gpdb/tree/master/gpcontrib/gp_sparse_vector/README" format="html" scope="external" navtitle="gp_sparse_vector" linking="none"/>
    <topicref href="hstore.xml" linking="none"/>
    <topicref href="orafce_ref.xml" linking="none"/>
-    <topicref href="https://www.postgresql.org/docs/9.4/pageinspect.html" scope="external" format="html" navtitle="pageinspect" linking="none"/>
+    <topicref href="pageinspect.xml" linking="none"/>
    <topicref href="pgcrypto.xml" linking="none"/>
  </topicref>
 </map>
--- a/gpdb-doc/dita/ref_guide/modules/pageinspect.xml
+++ b/gpdb-doc/dita/ref_guide/modules/pageinspect.xml
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
+<dita>
+  <topic id="topic_fstrm">
+    <title>pageinspect</title>
+    <body>
+      <p>The <codeph>pageinspect</codeph> module provides functions for low level
+         inspection of the contents of database pages. <codeph>pageinspect</codeph>
+         is available only to Greenplum Database superusers.</p>
+      <p>The Greenplum Database <codeph>pageinspect</codeph> module is based on the
+        PostgreSQL <codeph>pageinspect</codeph> module. The Greenplum version of the
+        module differs only in that it does not allow inspection of pages belonging to
+        append-optimized or external relations.</p>
+    </body>
+    <topic id="topic_reg">
+      <title>Installing and Registering the Module</title>
+      <body>
+        <p>The <codeph>pageinspect</codeph> module is installed when you install
+          Greenplum Database. Before you can use any of the functions defined in the
+          module, you must register the <codeph>pageinspect</codeph> extension in
+          each database in which you want to use the functions.
+          <ph otherprops="pivotal">Refer to <xref href="../../install_guide/install_modules.xml"
+            format="dita" scope="peer">Installing Additional Supplied Modules</xref>
+          for more information.</ph></p>
+      </body>
+    </topic>
+    <topic id="topic_info">
+      <title>Module Documentation</title>
+      <body>
+        <p>See <codeph><xref href="https://www.postgresql.org/docs/9.4/pageinspect.html"
+            scope="external" format="html">pageinspect</xref></codeph> in the PostgreSQL
+          documentation for detailed information about the individual functions in
+          this module.</p>
+      </body>
+    </topic>
+  </topic>
+</dita>