Setup workflow for doc publish#414
Conversation
|
@luoyuxia Appreciate a review here |
There was a problem hiding this comment.
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-pagesbranch. - Configure GitHub Pages publishing via
.asf.yamland 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.
| name: Deploy Documentation | ||
|
|
||
| on: | ||
| workflow_dispatch: |
There was a problem hiding this comment.
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.
| workflow_dispatch: | |
| workflow_dispatch: | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - 'website/**' |
There was a problem hiding this comment.
Do we need to update when main changed?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Thanks. Make sense to me. I think in the future, we can support mutiple version website just like fluss-main repo
luoyuxia
left a comment
There was a problem hiding this comment.
@leekeiabstraction Thanks for the great pr. Left minor comments. PTAL
| name: Deploy Documentation | ||
|
|
||
| on: | ||
| workflow_dispatch: |
There was a problem hiding this comment.
Do we need to update when main changed?
|
TY. Addressed comments, PTAL @luoyuxia |
Purpose
Linked issue: close #401
Setup workflow for doc publish