Merged
Conversation
nastra
approved these changes
Mar 11, 2024
Contributor
|
@manuzhang have you verified that all links works by locally running the site as described here? |
1. Fix internal links 2. Move `Type Compatibility` section from spark-writes.md to spark-getting-started.md
Collaborator
OopsApologies, as I sent this note and accidentally made a review instead of posted a comment. I generally don't dislike GH's UI but that one has bitten me quite a few times. I digress... Original / Updated note@manuzhang @nastra did you test the links locally? I realized after I asked this we haven't set up the That said, I'm pretty sure this will break the links if we don't revert the link changes in the next build as it works on the site now, and did the day before when I originally posted this. https://iceberg.apache.org/docs/latest/spark-configuration/#catalogs Links are a bit strange at the moment so depending on if you're in a subproject or top-level site, it will change how you address internal links. This is due to the number of directories between versioned mkdocs projects and the top level site change from static code to build. Static code analysis that is common practice in mkdocs will fail, hence all the warnings when you build. We knew this wasn't perfect going into it, but we just needed to get this out incrementally and will be slowly addressing this. So moving forward, I will create a PR to build locally so that any time we update docs, you will have an option to validate those changes in a local site, especially links, and I'll update the readme there. I'll also work on another PR to add nightly builds that will run a link check on the live site after each nightly build and generate a report, while still hosting the nightly build. @nastra, could you please revert just the links in this change and keep the content changes? Or if it's better, do the full revert and reapply only the content changes. Thanks! |
Member
Author
Contributor
|
Can we just have one single PR to fix all the broken links for the current version of the docs ( This is for exameple all of the current warnings against the current docs: |
Member
Author
Contributor
|
I don't think we want to merge #9939 because it only fixes some links. |
Member
Author
zachdisc
pushed a commit
to zachdisc/iceberg
that referenced
this pull request
Dec 23, 2024
1. Fix internal links 2. Move `Type Compatibility` section from spark-writes.md to spark-getting-started.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Type Compatibilitysection from spark-writes.md to spark-getting-started.md