markhoerth opened a new pull request, #12321:
URL: https://github.com/apache/gravitino/pull/12321
### What changes were proposed in this pull request?
Removes the "Since Version" column from configuration tables across the doc
set, along
with the equivalent inline references in prose ("since 0.6.0", "since
1.2.0").
54 files changed, all under `docs/`. No wording, structural, or other
content changes.
### Why are the changes needed?
The docs are version-selected. The doc set a reader is viewing already tells
them which
version the page describes, and every page carries a version badge above the
title, with
older versions getting a banner linking to the latest.
When the column names a prior release, the reader on the current page gains
nothing,
since the page they are reading should already be correct for their version.
When it
names a later release, it is telling the reader they are on the wrong page,
which the
badge and banner already do better.
Of seven comparable projects, only Spark keeps such a column, and Spark has
no version
picker. Flink, Iceberg, PostgreSQL, Polaris, Kafka, and Trino all omit it.
Discussed with @jerryshao, who agreed the change should cover the whole doc
set rather
than a single page.
### Does this PR introduce any user-facing change?
Yes, documentation only.
### How was this patch tested?
Verified no remaining "since version" or "since <number>" references outside
the excluded
files, and confirmed pipe alignment on modified tables.
### Notes for reviewers
Six files are excluded because they have rewrites in flight and drop the
column as part
of those rewrites: `lance-rest-service.md`, `lakehouse-generic-catalog.md`,
`lakehouse-generic-delta-table.md`, `lakehouse-generic-lance-table.md`,
`iceberg-rest-service.md`, `lakehouse-iceberg-catalog.md`.
`docs/fileset-catalog.md` line 187 has a table row with one fewer cell than
its header.
The row was already malformed before this change, so it is left in its
existing shape
rather than repaired here. A separate PR will fix it.
`docs/security/credential-vending.md` keeps its version context under the
"Upgrading From
a Release Earlier Than 1.3.0" heading, where the version is load-bearing.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
