Skip to content

Setup workflow for doc publish#414

Merged
luoyuxia merged 2 commits into
apache:mainfrom
leekeiabstraction:website
Mar 4, 2026
Merged

Setup workflow for doc publish#414
luoyuxia merged 2 commits into
apache:mainfrom
leekeiabstraction:website

Conversation

@leekeiabstraction

@leekeiabstraction leekeiabstraction commented Mar 2, 2026

Copy link
Copy Markdown
Contributor

Purpose

Linked issue: close #401

Setup workflow for doc publish

@leekeiabstraction

Copy link
Copy Markdown
Contributor Author

@luoyuxia Appreciate a review here

@leekeiabstraction leekeiabstraction changed the title Setup workflow for manual doc publish Setup workflow for doc publish Mar 2, 2026
@luoyuxia luoyuxia requested a review from Copilot March 3, 2026 02:42

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Sets up infrastructure to publish the Docusaurus documentation site for the Fluss clients repository, aligning the site configuration with a new custom domain and adding PWA assets.

Changes:

  • Add a GitHub Actions workflow to build the Docusaurus site and push the output to the gh-pages branch.
  • Configure GitHub Pages publishing via .asf.yaml and add a custom domain (CNAME).
  • Enable Docusaurus PWA support (plugin config + web manifest).

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
website/static/manifest.json Adds a web app manifest for PWA installation.
website/static/CNAME Configures the custom domain for GitHub Pages.
website/package.json Adds the Docusaurus PWA plugin dependency.
website/docusaurus.config.ts Updates site URL/baseUrl for the custom domain and configures PWA plugin.
.github/workflows/deploy_documentation.yml Adds a manual deployment workflow that builds and pushes to gh-pages.
.asf.yaml Enables ASF GitHub Pages publishing from gh-pages at / and updates homepage URL.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread website/static/manifest.json
Comment thread website/package.json
Comment thread .github/workflows/deploy_documentation.yml
name: Deploy Documentation

on:
workflow_dispatch:

Copilot AI Mar 3, 2026

Copy link

Choose a reason for hiding this comment

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

This workflow only runs on workflow_dispatch. If the intent is to “publish docs” automatically when website/** changes on main (as implied by the linked issue), consider adding a push trigger (optionally filtered by paths: ['website/**']) so deployments happen without manual intervention.

Suggested change
workflow_dispatch:
workflow_dispatch:
push:
branches:
- main
paths:
- 'website/**'

Copilot uses AI. Check for mistakes.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Do we need to update when main changed?

@leekeiabstraction leekeiabstraction Mar 3, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

No we do not need to update every time when main changed, it's workflow_dispatch (manual) only. We can have a separate doc branch if we'd like that. Do you have something specific in mind?

Note also that the workflow does compile, commit and push to gh-pages branch which Gh Pages serve from.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks. Make sense to me. I think in the future, we can support mutiple version website just like fluss-main repo

Comment thread .github/workflows/deploy_documentation.yml
Comment thread website/docusaurus.config.ts

@luoyuxia luoyuxia left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@leekeiabstraction Thanks for the great pr. Left minor comments. PTAL

name: Deploy Documentation

on:
workflow_dispatch:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Do we need to update when main changed?

Comment thread .github/workflows/deploy_documentation.yml
Comment thread website/docusaurus.config.ts
@leekeiabstraction

Copy link
Copy Markdown
Contributor Author

TY. Addressed comments, PTAL @luoyuxia

@luoyuxia luoyuxia merged commit 2ceb512 into apache:main Mar 4, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Setup CI workflow to push to fluss-website/equivalent on fluss-rust side

3 participants