Skip to content

Conversation

@kevinjqliu
Copy link
Contributor

@kevinjqliu kevinjqliu commented Oct 27, 2025

Follow up to #13977

This PR adds make lint and make lint-fix to site/'s Makefile.
This PR also creates a python virtual env to install the required libraries and runs docs-ci with ubuntu and macos

Tested

rm -rf .venv/
make lint
make lint-fix

# edited docs/docs/api.md
make lint
make lint-fix

make build

@kevinjqliu kevinjqliu added the website Style-issues related to the Iceberg website label Oct 27, 2025
deploy: # Clean, build, and deploy the Iceberg docs site.
dev/deploy.sh $(remote_name)

.PHONY: lint
Copy link
Member

Choose a reason for hiding this comment

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

Please update README for these commands.

set -e

export REMOTE="iceberg_docs"
export VENV_DIR=".venv"
Copy link
Member

Choose a reason for hiding this comment

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

do we ever clean up this dir?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

i dont think so. i could add it to the clean command, but i think its also fine to leave it alone

@manuzhang
Copy link
Member

@kevinjqliu Thanks for the follow-up PR. Can you also help to add macos-latest to Docs CI?

@kevinjqliu kevinjqliu requested a review from manuzhang October 28, 2025 02:10
site/README.md Outdated
```

It will also scan all markdown files and fail the build on any style issues. To fix style issues, run the `lint` script with fix mode.
It will also scan all markdown files and fail the build on any style issues. To fix style issues, run the `lint-fix` make command.
Copy link
Member

Choose a reason for hiding this comment

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

I don't think we need to mention lint-fix here, since it will be immediately covered in the following section.

@kevinjqliu kevinjqliu merged commit 1155314 into apache:main Nov 3, 2025
4 checks passed
@kevinjqliu kevinjqliu deleted the kevinjqliu/make-lint branch November 3, 2025 01:58
@manuzhang
Copy link
Member

@kevinjqliu Sorry, although my approval is marked green by GitHub, I'm not a committer and that should not count as one.

@kevinjqliu
Copy link
Contributor Author

oops, good catch @manuzhang. let me ping someone else

@huaxingao
Copy link
Contributor

Late LGTM

@kevinjqliu
Copy link
Contributor Author

Thank you @huaxingao.
Sorry about the eager merge, happy to revert or fix forward.

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

Labels

docs INFRA website Style-issues related to the Iceberg website

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants