Skip to content

[SPARK-49174][BUILD][DOCS] Exclude the dir docs/util from _site#47678

Closed
panbingkun wants to merge 2 commits intoapache:masterfrom
panbingkun:SPARK-49174
Closed

[SPARK-49174][BUILD][DOCS] Exclude the dir docs/util from _site#47678
panbingkun wants to merge 2 commits intoapache:masterfrom
panbingkun:SPARK-49174

Conversation

@panbingkun
Copy link
Copy Markdown
Contributor

@panbingkun panbingkun commented Aug 9, 2024

What changes were proposed in this pull request?

The pr aims to exclude the dir docs/util from _site.
eg: https://spark.apache.org/docs/4.0.0-preview1/util/build-error-docs.py

Why are the changes needed?

Eliminate unnecessary files in the site.
ref: https://jekyllrb.com/docs/configuration/options/

Does this PR introduce any user-facing change?

No.

How was this patch tested?

Manually check.

Was this patch authored or co-authored using generative AI tooling?

No.

@github-actions github-actions bot added the DOCS label Aug 9, 2024
@panbingkun panbingkun changed the title [SPARK-49174][BUILD][DOCS] Exclude the dir docs/util from doc build [SPARK-49174][BUILD][DOCS] Exclude the dir docs/util from _site Aug 9, 2024
@panbingkun panbingkun marked this pull request as ready for review August 9, 2024 06:22
@panbingkun
Copy link
Copy Markdown
Contributor Author

cc @yaooqinn

@yaooqinn
Copy link
Copy Markdown
Member

yaooqinn commented Aug 9, 2024

@panbingkun
Copy link
Copy Markdown
Contributor Author

Can it be moved to https://github.com/apache/spark/tree/master/docs/_plugins?

I'll give it a try.

@yaooqinn
Copy link
Copy Markdown
Member

yaooqinn commented Aug 9, 2024

Thank you @panbingkun

@panbingkun
Copy link
Copy Markdown
Contributor Author

Can it be moved to https://github.com/apache/spark/tree/master/docs/_plugins?

It's okay, and I have verified again the content of the site folder generated by GA,
the util no longer exists, and there are no other issues with the content.

Copy link
Copy Markdown
Member

@yaooqinn yaooqinn left a comment

Choose a reason for hiding this comment

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

LGTM

@yaooqinn
Copy link
Copy Markdown
Member

yaooqinn commented Aug 9, 2024

Merged to master

@yaooqinn yaooqinn closed this in 81948bb Aug 9, 2024
@panbingkun
Copy link
Copy Markdown
Contributor Author

Thanks @yaooqinn

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants