vmware-archive / sre-test

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

Internal hyperlink references to topics should use their matching titles #279

Open indranil-cg opened 2 years ago

indranil-cg commented 2 years ago

Location: https://gpdb.docs.pivotal.io/pxf/6-2/using/about_pxf_dir.html#installed About the PXF Installation and Configuration Directories -> PXF Installation Directories

The second table that explains the directories in $PXF_BASE has hyperlink parts of sentences that reference topics elsewhere in the document. The hyperlink text sections within the sentence do not match the titles/headings they refer to hence making navigation difficult. For example:

The location of user-customizable PXF configuration files for PXF runtime and logging configuration settings. -> Topic: About the PXF Configuration Files The location of user-added runtime dependencies. -> Topic: Registering PXF Library Dependencies The PXF runtime log file directory. -> Topic: Logging The configuration directory for PXF servers. -> Topic: Configuring PXF Servers

The hyperlinks within the sentences can be removed and instead add text such as "For more details refer to <title of topic>." at the end of the paragraphs.