prestodb/presto

[docs] move Cache/Alluxio into Connectors/Hive doc

Open

#21511 opened on Dec 11, 2023

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Java (15,558 stars) (5,240 forks)batch import
docsfeature requestgood first issue

Description

Because caching is connector-specific, the Presto documentation should include caching docs in the appropriate connector documentation. Recommend moving the content in Cache into or underneath Hive Connector docs.

Expected Behavior or Use Case

Caching documentation should be located where it is most valuable. Because caching is connector-specific, this should be in the Connectors part of presto-docs.

Presto Component, Service, or Connector

Presto documentation.

Possible Implementation

Instead of moving the content into the single Hive Connector page, perhaps create a new page "Hive Cache" in /connectors and add it to Connectors, directly under Hive Security Configuration.

Example Screenshots (if appropriate):

Context

Improving the Presto docs architecture by moving content to where it is relevant.

Contributor guide

Tech stack
javasql
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic understanding of Presto documentation structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95
Research direction
Examine the existing Cache page source file (likely in presto docs/src/main/sphinx/cache.rst) and the Hive Connector documentation files. Create a new Sphinx page for Hive Cache under the connectors directory and update the table of contents (index.rst) to include it. Ensure cross references and links are preserved. The issue provides guidance on placement under Hive Security Configuration.