Skip to content

Conversation

@enesyesil
Copy link

@enesyesil enesyesil commented Nov 2, 2025

Closes #14411

@github-actions github-actions bot added the docs label Nov 2, 2025
@enesyesil enesyesil mentioned this pull request Nov 2, 2025
3 tasks
Copy link
Contributor

@ebyhr ebyhr left a comment

Choose a reason for hiding this comment

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

Could you please add a screenshot to the PR description? It will help the reviewers.

@kevinjqliu
Copy link
Contributor

Thanks for working on this.

You can run make serve in the site/ dir to render the site locally so that we can preview the changes.
We should also figure out where best to places these links within the nav

@enesyesil
Copy link
Author

Thanks for the feedback.
I also noticed in #14399
that suggested the following structure:
“FileIO could go under the API section, About can be removed, and the rest can be moved into the Project tab.”

Before I make any further updates, could you please confirm if this layout is preferred? and I will also include a screenshot of updated nav layout in the PR.

@kevinjqliu
Copy link
Contributor

I think FileIO under API makes sense

We can get rid of About, the same paragraph is on the homepage

Benchmark and Security in the project tab also makes sense

@kevinjqliu kevinjqliu added the website Style-issues related to the Iceberg website label Nov 4, 2025
@enesyesil
Copy link
Author

Hi, I just pushed the latest changes. the File I/O link was added under the api section, other links also updated. Please have a look when you get a chance, and let me know if I should adjust anything else. Thanks a lot for the help and feedback

Copy link
Contributor

@kevinjqliu kevinjqliu left a comment

Choose a reason for hiding this comment

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

thanks @enesyesil

could you run make serve-dev locally from the site/ dir to preview the changes and post the preview?

docs/mkdocs.yml Outdated
- API:
- Quickstart: java-api-quickstart.md
- API: api.md
- File I/O: ../../fileio/
Copy link
Contributor

Choose a reason for hiding this comment

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

weird thing i noticed while rendering this locally.

api.md / https://iceberg.apache.org/docs/nightly/api/
has a side bar

but fileio does not.

i didnt see where this is controlled but would be good to keep the consistency here

@enesyesil
Copy link
Author

Hi, yeah I guess the reason is that MkDocs builds from the docs/ directory, so linking with ../../fileio/ jumps outside the build and loses the sidebar context.

Do you think it would be better to move the fileio docs into docs/, or just mirror them there to keep consistency?

@enesyesil
Copy link
Author

Screenshot 2025-11-06 at 11 09 54 PM

@enesyesil
Copy link
Author

Sorry for the delay. File I/O now appears under the API section with the sidebar showing correctly, I verified locally.
Thanks for the review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs website Style-issues related to the Iceberg website

Projects

None yet

Development

Successfully merging this pull request may close these issues.

site: dangling doc pages

3 participants