Skip to content

Docs: Fix internal links in 1.5.x releases#10411

Merged
nastra merged 1 commit intoapache:docsfrom
manuzhang:fix-links
Jun 4, 2024
Merged

Docs: Fix internal links in 1.5.x releases#10411
nastra merged 1 commit intoapache:docsfrom
manuzhang:fix-links

Conversation

@manuzhang
Copy link
Member

@manuzhang manuzhang commented Jun 1, 2024

@bitsondatadev
Copy link
Collaborator

@manuzhang have you tried running this locally?

@Fokko
Copy link
Contributor

Fokko commented Jun 3, 2024

@bitsondatadev After this PR we need to fix this in the docs branch, right?

@manuzhang
Copy link
Member Author

@Fokko This PR is open against docs branch.

| cache-enabled | true | Whether to cache catalog entries |
| cache.expiration-interval-ms | 30000 | How long catalog entries are locally cached, in milliseconds; 0 disables caching, negative values disable expiration |
| metrics-reporter-impl | org.apache.iceberg.metrics.LoggingMetricsReporter | Custom `MetricsReporter` implementation to use in a catalog. See the [Metrics reporting](../metrics-reporting.md) section for additional details |
| metrics-reporter-impl | org.apache.iceberg.metrics.LoggingMetricsReporter | Custom `MetricsReporter` implementation to use in a catalog. See the [Metrics reporting](metrics-reporting.md) section for additional details |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm surprised that this is an issue in the 1.5.2 docs given that ##9965 fixed this before 1.5.2 went out. @amogh-jahagirdar I'm guessing docs-wise for #10282 you were probably just using whatever existed for the 1.5.1 docs? At that time we most likely just haven't had backports for the link fixes

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At that time we most likely just haven't had backports for the link fixes

Exactly. #9965 got merged (March 23, 2024) after the 1.5.0 release (March 11, 2024), so those fixes are not on the 1.5.x branch.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just so it's clear I still have a link fix en route, I just need to recall the decision we made regarding absolute vs relative links.

@nastra
Copy link
Contributor

nastra commented Jun 3, 2024

@manuzhang did you run this locally and do the links across versions work now correctly?

@manuzhang
Copy link
Member Author

@nastra As @Fokko said, #9965 wan't merged in time for 1.5.x branch and this PR basically back-ports the patch (resolving minor conflicts). I've built site locally and manually checked some links. They are working correctly now.

Copy link
Contributor

@Fokko Fokko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Thanks for taking care of this @manuzhang

We can check afterwards if we missed anything by running the link checker #10404 (comment)

@nastra
Copy link
Contributor

nastra commented Jun 4, 2024

thanks for taking care of this @manuzhang

@nastra nastra merged commit d3aba61 into apache:docs Jun 4, 2024
@manuzhang manuzhang deleted the fix-links branch June 4, 2024 11:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants