vmware-archive / sre-test

Greenplum - Open Source SRE test project.
2 stars 0 forks source link

PXF document should describe the steps for the selected version #250

Open indranil-cg opened 2 years ago

indranil-cg commented 2 years ago

When a user selects the PXF documentation version from the header bar, the corresponding document should describe the steps for the selected version only.

The document should mention at the beginning of the document that "This document describes the installation, configuration and administration of the selected version of PXF, for documentation of the bundled version of PXF with Greenplum database, please select the corresponding PXF version from the drop down list above".

Now if the user installed GPDB 6.18.2 in which PXF v5.15.1 is bundled (document must include steps on how to determine the version of PXF that is bundled), they should select 5.15 from the drop down and navigate to the documentation for that specific version. and if they are installing say rpm for version 6.2 they select 6.2 from the drop down.

At the present the documented steps switch between the bundled version and the selected version throughout the document, making it hard to follow especially for an inexperienced user. As an example this topic: https://gpdb.docs.pivotal.io/pxf/6-2/using/about_pxf_dir.html