You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@iceberg.apache.org by "manuzhang (via GitHub)" <gi...@apache.org> on 2025/04/28 09:37:20 UTC
[I] Docs: Merge latest doc with latest version doc [iceberg]
manuzhang opened a new issue, #12917:
URL: https://github.com/apache/iceberg/issues/12917
### Feature Request / Improvement
Currently, there is a `latest` doc and latest `$version` doc with identical contents. Ideally, they should be merged together and displayed as `$version (latest)`.
### Query engine
None
### Willingness to contribute
- [ ] I can contribute this improvement/feature independently
- [ ] I would be willing to contribute this improvement/feature with guidance from the Iceberg community
- [ ] I cannot contribute this improvement/feature at this time
--
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: issues-unsubscribe@iceberg.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [I] Docs: Merge latest doc with latest version doc [iceberg]
Posted by "rmoff (via GitHub)" <gi...@apache.org>.
rmoff commented on issue #12917:
URL: https://github.com/apache/iceberg/issues/12917#issuecomment-3078348456
@manuzhang any more thoughts on this? I'm happy to put a PR together for it.
--
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: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [I] Docs: Merge latest doc with latest version doc [iceberg]
Posted by "rmoff (via GitHub)" <gi...@apache.org>.
rmoff commented on issue #12917:
URL: https://github.com/apache/iceberg/issues/12917#issuecomment-3053050185
I agree. So how about this kind of thing.
1. Default to latest version (drop the `latest` terminology)
<img width="1118" height="862" alt="Image" src="https://github.com/user-attachments/assets/7e192be1-62d4-4350-a52b-d04db0ef1795" />
2. Keep the earlier versions, but move to a sub menu
<img width="1108" height="764" alt="Image" src="https://github.com/user-attachments/assets/bc883d63-b43b-4f71-86ab-8349218d5805" />
--
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: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [I] Docs: Merge latest doc with latest version doc [iceberg]
Posted by "rmoff (via GitHub)" <gi...@apache.org>.
rmoff commented on issue #12917:
URL: https://github.com/apache/iceberg/issues/12917#issuecomment-3053146897
What about
```
1.9.1
> Other versions
```
```
1.9.1
V Other versions
nightly
1.9.0
1.8.1
etc
```
--
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: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [I] Docs: Merge latest doc with latest version doc [iceberg]
Posted by "manuzhang (via GitHub)" <gi...@apache.org>.
manuzhang commented on issue #12917:
URL: https://github.com/apache/iceberg/issues/12917#issuecomment-3053075925
I think we'd better keep `nightly` for people to check documentation changes immediately.
--
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: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [I] Docs: Merge latest doc with latest version doc [iceberg]
Posted by "manuzhang (via GitHub)" <gi...@apache.org>.
manuzhang closed issue #12917: Docs: Merge latest doc with latest version doc
URL: https://github.com/apache/iceberg/issues/12917
--
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: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [I] Docs: Merge latest doc with latest version doc [iceberg]
Posted by "rmoff (via GitHub)" <gi...@apache.org>.
rmoff commented on issue #12917:
URL: https://github.com/apache/iceberg/issues/12917#issuecomment-3096078133
> Ideally, they should be merged together and displayed as $version (latest).
This is now implemented with #13491, so I think can be closed?
<img width="882" height="1210" alt="Image" src="https://github.com/user-attachments/assets/ae4f93c0-07aa-48ce-83ea-fc2883a27a59" />
--
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: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [I] Docs: Merge latest doc with latest version doc [iceberg]
Posted by "rmoff (via GitHub)" <gi...@apache.org>.
rmoff commented on issue #12917:
URL: https://github.com/apache/iceberg/issues/12917#issuecomment-3052840457
I agree that _both_ `latest` and `1.9.1` becomes confusing (is 1.9.1 not the latest?) and takes up more nav space.
Before we fix it thought, a couple of thoughts:
## Navigation
Do we even need the term `latest`? Or we show the latest version (e.g. `1.9.1`) as current and people can take from that that it's the latest version?
## Permalinks
Ideally someone linking to the current version of the docs should not be baking in a link that's then hardcoded to a version which ages and thus their link ages. *Unless* they are deliberately wanting to link to a specific version's docs. But this feels like something that's contrary to the principle of hyperlinks in general, so I discount it.
---
For reference, Apache Kafka has their docs link `https://kafka.apache.org/documentation/` serving docs for the latest version, and just lists the version number in the heading; there's no `latest` terminology.
<img width="2240" height="1252" alt="Image" src="https://github.com/user-attachments/assets/dc4c8dfe-a104-427b-a687-f6b4a8931388" />
Apache Flink does the same `https://nightlies.apache.org/flink/flink-docs-stable/`
<img width="2394" height="530" alt="Image" src="https://github.com/user-attachments/assets/88573a30-3b83-47a2-b041-bef3479af8a2" />
--
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: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [I] Docs: Merge latest doc with latest version doc [iceberg]
Posted by "manuzhang (via GitHub)" <gi...@apache.org>.
manuzhang commented on issue #12917:
URL: https://github.com/apache/iceberg/issues/12917#issuecomment-3052933253
Flink website does have such terminology as stable, LTS, snapshot in the `Documentation` pull-down.
<img width="2942" height="1984" alt="Image" src="https://github.com/user-attachments/assets/d8cd7e9a-58a6-4aa9-807b-33a70f01a327" />
I think we should make it easy for users to find docs of previous versions, since not everyone is using the latest.
--
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: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org