apache / iceberg

Apache Iceberg
https://iceberg.apache.org/
Apache License 2.0
6.44k stars 2.23k forks source link

Fix header links with underscores in title. #9617

Closed bitsondatadev closed 2 weeks ago

bitsondatadev commented 9 months ago

The current link fails for the current site: https://iceberg.apache.org/docs/latest/spark-procedures/#expire-snapshots

The reason my linkchecker missed this was that it still loads the page just not the link. So we'll need to do a pass at these in a later PR.

raghits commented 9 months ago

@bitsondatadev looks like https://iceberg.apache.org/docs/latest/spark-procedures/#expire_snapshots is valid URL. Should we use _ underscore instead of hyphen - for these links?

bitsondatadev commented 9 months ago

To keep compatibility with the old site, we should support both. The only time this becomes an issue is if you have a saved link (or Google in the short term) but using the - will still take you to the page, just not the header.

For now use _ and if there becomes a real need we'll implement it.

raghits commented 9 months ago

Thanks. Sounds good. Also, looks like all procedure names have a _ separator. So it would be consistent with that convention.

bitsondatadev commented 9 months ago

Thanks for this @raghits, have you noticed any other header not using the underscore?

I haven't checked myself.

raghits commented 9 months ago

@bitsondatadev here are the references where the hyphen (expire-snapshots) is used but those URLs valid and hence I didn't update it: https://github.com/apache/iceberg/blob/main/docs/docs/spark-structured-streaming.md https://github.com/apache/iceberg/blob/main/docs/docs/flink-writes.md

github-actions[bot] commented 4 weeks ago

This issue has been automatically marked as stale because it has been open for 180 days with no activity. It will be closed in next 14 days if no further activity occurs. To permanently prevent this issue from being considered stale, add the label 'not-stale', but commenting on the issue is preferred when possible.

github-actions[bot] commented 2 weeks ago

This issue has been closed because it has not received any activity in the last 14 days since being marked as 'stale'