apache / apache/arrow-java

[Docs][Java] Install document uses <arrow.version>9.0.0</arrow.version>

Open
#195 0 comments 0 reactions 0 assignees View on GitHub
Component: Documentation Type: enhancement
Dominant language
Java
Stars
94
Forks
152
Avg merge
3d 16h
Merged PRs (30d)
11

Description

### Describe the enhancement requested

https://arrow.apache.org/docs/java/install.html

Can we use the current release version number instead of `9.0.0` automatically?

We may be able to use Sphinx's (reST's) substitution feature for this.
See also:
* https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#substitutions
* https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#default-substitutions

Reported by @headius in https://github.com/apache/arrow/issues/35589#issuecomment-1548095081 .

### Component(s)

Documentation, Java

Contributor guide

Open the contributing guide

Research direction

Start with the Java installation page at https://arrow.apache.org/docs/java/install.html and review the linked Sphinx substitution documentation. Trace where the release version is defined and make the rendered page use the current release instead of the hardcoded 9.0.0; confirm the generated documentation shows the current version.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.