-
Notifications
You must be signed in to change notification settings - Fork 2.9k
Docs: add missing pages (about, benchmarks, fileio, security) to site… #14481
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
ebyhr
left a comment
There was a problem hiding this 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.
|
Thanks for working on this. You can run |
|
Thanks for the feedback. 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. |
|
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 |
|
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 |
kevinjqliu
left a comment
There was a problem hiding this 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/ |
There was a problem hiding this comment.
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
|
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? |
|
Sorry for the delay. File I/O now appears under the API section with the sidebar showing correctly, I verified locally. |

Closes #14411