Skip to content
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

[SPARK-49495][DOCS] Document and Feature Preview on the master branch via Live GitHub Pages Updates #47968

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

yaooqinn
Copy link
Member

@yaooqinn yaooqinn commented Sep 3, 2024

What changes were proposed in this pull request?

This pull request introduces functionalities that enable 'Document and Feature Preview on the master branch via Live GitHub Pages Updates'.

Why are the changes needed?

  • Instead of limited 72-hour voting phases, it provides the developer community with more opportunities to preview and verify the documentation contents.
  • Instead of waiting for the final announcement of an official spark feature release, users can now preview some of the ongoing documented features, increasing the willingness to upgrade, sensing breaking changes in advance, and reducing the burden during the final upgrades.

Does this PR introduce any user-facing change?

No

How was this patch tested?

An example has been established by this repo - https://github.com/yaooqinn/spark-gh-pages

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

no

@github-actions github-actions bot added the INFRA label Sep 3, 2024
@HyukjinKwon
Copy link
Member

While it's great to have the documentation for the latest development branch, I wonder if it's better to have the actual full nightly build and/or frequent release instead via setting up the release automation process.

My concern is that the Google result might show this page first, and people might get confused of, e.g., the new features in development.

@HyukjinKwon
Copy link
Member

Actually one of my colleagues is working on setting up the release automation, cc @bozhang2820 WDYT?

@yaooqinn
Copy link
Member Author

yaooqinn commented Sep 3, 2024

Thank you for the feedback @HyukjinKwon.

I wonder if it's better to have the actual full nightly build

This action can be scheduled w/ cron or via push, I tended to submit this PR using the push-and-cancelation trigger for a more up-to-date doc view.

We can benefit from this for a post-review on docs-related PRs

frequent release

While I'm also a supporter of the 'Release Early, release often' principle, after being the RM for 3.5.2, I think this could cost much on the infrastructures, such as 'pypi', 'ASF svn', 'mvn central', 'docker registry', e.t.c.

My concern is that the Google result might show this page first

image

This site will be marked as 'in-progress' or something else to reduce the ambiguity. Also, some directives of reStructuredText or markdown can be used in the doc build phase to enhance the warnings within a page in follow-up PRs.

Copy link
Member

@dongjoon-hyun dongjoon-hyun left a comment

Choose a reason for hiding this comment

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

Thank you, @yaooqinn . I guess we need a vote for this because GitHub Pages is a new channel from Apache Spark perspective.

If we use the official nightly channel, we may avoid the vote. However, IIUC, you want to use GitHub Pages specifically here, right, @yaooqinn ?

@yaooqinn
Copy link
Member Author

yaooqinn commented Sep 3, 2024

Thank you @dongjoon-hyun, I will raise a discussion thread in dev soon

@dongjoon-hyun
Copy link
Member

Thank you!

@HyukjinKwon
Copy link
Member

+1 for going for a vote. I think that'd be easier to decide.

@yaooqinn yaooqinn changed the title [SPARK-49495][SQL] Document and Feature Preview on the master branch via Live GitHub Pages Updates [SPARK-49495][DOCS] Document and Feature Preview on the master branch via Live GitHub Pages Updates Sep 4, 2024
HyukjinKwon pushed a commit that referenced this pull request Sep 4, 2024
### What changes were proposed in this pull request?

Fix site.SPARK_VERSION pattern in RDD Programming Guide. I found this when I was developing #47968

### Why are the changes needed?
doc fix

### Does this PR introduce _any_ user-facing change?

no

### How was this patch tested?

doc build

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

no

Closes #47985 from yaooqinn/version.

Authored-by: Kent Yao <yao@apache.org>
Signed-off-by: Hyukjin Kwon <gurwls223@apache.org>
HyukjinKwon pushed a commit that referenced this pull request Sep 4, 2024
Fix site.SPARK_VERSION pattern in RDD Programming Guide. I found this when I was developing #47968

doc fix

no

doc build

no

Closes #47985 from yaooqinn/version.

Authored-by: Kent Yao <yao@apache.org>
Signed-off-by: Hyukjin Kwon <gurwls223@apache.org>
(cherry picked from commit 90a236e)
Signed-off-by: Hyukjin Kwon <gurwls223@apache.org>
@yaooqinn
Copy link
Member Author

yaooqinn commented Sep 4, 2024

FYI, I have sent a mail to the dev https://lists.apache.org/thread/xojcdlw77pht9bs4mt4087ynq6k9sbqq

@dongjoon-hyun
Copy link
Member

dongjoon-hyun commented Sep 11, 2024

I saw the vote thread a few minutes ago. I voted. Thank you! :)

https://lists.apache.org/thread/lw6rqkvvth44ykncpjy52qjctmbdyrzq

Copy link
Member

@dongjoon-hyun dongjoon-hyun left a comment

Choose a reason for hiding this comment

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

+1, LGTM. I believe we can merge this after the vote passes.

.github/workflows/pages.yml Outdated Show resolved Hide resolved
.github/workflows/pages.yml Outdated Show resolved Hide resolved

concurrency:
group: 'docs preview'
cancel-in-progress: true
Copy link
Member

Choose a reason for hiding this comment

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

This makes the build dependent on each other. E.g., if you have commit 1,2,3 at the same time, build 1 has to be finished before starting build 2. Can we maybe just do this as a scheduled job to save resources?

Copy link
Member Author

Choose a reason for hiding this comment

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

if you have commit 1,2,3 at the same time, build 1 has to be finished before starting build 2

1 and 2 will be canceled by 3.

.github/workflows/pages.yml Outdated Show resolved Hide resolved
yaooqinn and others added 2 commits September 12, 2024 10:00
Co-authored-by: Hyukjin Kwon <gurwls223@gmail.com>
Co-authored-by: Hyukjin Kwon <gurwls223@gmail.com>
.github/workflows/pages.yml Outdated Show resolved Hide resolved
@yaooqinn
Copy link
Member Author

Thank you @dongjoon-hyun and @HyukjinKwon

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.

3 participants