You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@fluss.apache.org by "wuchong (via GitHub)" <gi...@apache.org> on 2026/04/18 08:32:42 UTC

[I] [website] Move blog content to a separate repository [fluss]

wuchong opened a new issue, #3128:
URL: https://github.com/apache/fluss/issues/3128

   ## Motivation
   
   The `website/blog/` directory in the main Fluss repository contains blog posts along with a large number of image assets (22 subdirectories under `blog/assets/`). As the blog grows, these binary files significantly increase the repository size, slow down clones, and add noise to the main codebase which is primarily focused on the Fluss engine itself.
   
   ## Proposal
   
   Move the blog content (`website/blog/`) to a dedicated repository (e.g., `apache/fluss-blog`), while ensuring:
   
   1. **Standalone blog preview** — The blog repo includes a minimal Docusaurus setup so authors can run `npm start` locally to preview blog posts independently, without needing the full website.
   2. **Seamless website integration** — A `website/setup_blog.sh` script in the main repo clones the blog repo and places its content at `website/blog/` before the website build. This is transparent to the existing Docusaurus configuration.
   3. **CI integration** — The `docs-check.yaml` workflow runs `setup_blog.sh` automatically, so the full website (with blog) continues to build and deploy as before.
   
   ### Changes in the main repo
   
   | File | Change |
   |------|--------|
   | `website/setup_blog.sh` | New script to clone blog repo into `website/blog/` |
   | `.gitignore` | Add `website/blog` entry |
   | `.github/workflows/docs-check.yaml` | Add "Setup blog content" step before build |
   | `website/blog/` | Remove from git (after blog repo is live) |
   
   ### Blog repo structure
   
   ```
   fluss-blog/
   ├── blog/                     # Blog content (maps to website/blog/)
   │   ├── *.md                  # Blog posts
   │   ├── assets/               # Image assets
   │   ├── releases/             # Release notes
   │   ├── authors.yml
   │   └── tags.yml
   ├── static/img/               # Assets for standalone preview
   │   ├── avatars/
   │   └── logo/
   ├── docusaurus.config.ts      # Minimal blog-only Docusaurus config
   ├── package.json
   └── ...
   ```
   
   ## Benefits
   
   - **Smaller main repo** — Removes large binary assets from the engine repository, resulting in faster clones and smaller checkout sizes.
   - **Independent blog workflow** — Blog authors can write, preview, and iterate on posts without touching the main codebase. No need to build the full website locally.
   - **Separate commit history** — Blog changes (especially image additions) no longer pollute the main repo history and git blame.
   - **Flexible permissions** — The blog repo can have its own set of contributors and review processes.
   
   ## Drawbacks
   
   - **Extra setup step** — Website developers need to run `setup_blog.sh` once before local development. CI also needs this step.
   - **Cross-repo coordination** — When a blog post links to docs pages, broken links can only be caught during the full website build (not in the standalone blog preview).
   - **Two repos to maintain** — Blog deployment depends on both repos being in sync. The `apache/fluss-website` deployment workflow also needs to be updated to run the setup script.
   - **Asset duplication** — Author avatars and logos are copied to the blog repo for standalone preview, creating a small amount of duplication with `website/static/img/`.
   
   ## Alternatives Considered
   
   - **Git submodule**: Simpler integration but submodules add complexity for contributors (e.g., forgetting `--recurse-submodules`).
   - **Symlink**: Works for local dev but does not work in CI without additional scripting.
   - **Keep as-is**: Simplest, but the repository size will continue to grow as more blog posts and images are added.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@fluss.apache.org.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] [website] Move blog content to a separate repository [fluss]

Posted by "wuchong (via GitHub)" <gi...@apache.org>.
wuchong commented on issue #3128:
URL: https://github.com/apache/fluss/issues/3128#issuecomment-4273247209

   cc @polyzos @fresh-borzoni , what do you think?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@fluss.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] [website] Move blog content to a separate repository [fluss]

Posted by "fresh-borzoni (via GitHub)" <gi...@apache.org>.
fresh-borzoni commented on issue #3128:
URL: https://github.com/apache/fluss/issues/3128#issuecomment-4273515564

   @wuchong Why only the blog? 
   Most comparable ASF projects split the whole website into a separate repo - the rest of `website` accumulates binary assets too. 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@fluss.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] [website] Move blog content to a separate repository [fluss]

Posted by "wuchong (via GitHub)" <gi...@apache.org>.
wuchong commented on issue #3128:
URL: https://github.com/apache/fluss/issues/3128#issuecomment-4273283109

   I think the primary maintenance overhead involves synchronizing CSS and formatting across both platforms. However, given that CSS updates are infrequent, real-time synchronization is not critical, and any latency in syncing will not break the website. 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@fluss.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] [website] Move blog content to a separate repository [fluss]

Posted by "wuchong (via GitHub)" <gi...@apache.org>.
wuchong closed issue #3128: [website] Move blog content to a separate repository
URL: https://github.com/apache/fluss/issues/3128


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@fluss.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] [website] Move blog content to a separate repository [fluss]

Posted by "polyzos (via GitHub)" <gi...@apache.org>.
polyzos commented on issue #3128:
URL: https://github.com/apache/fluss/issues/3128#issuecomment-4273277704

   @wuchong I had similar thoughts.
   To me it makes sense and periodically we could also expire older content that might not be relevant anymore (or just update it i guess).
   
   But yeah we use so many images, that long term it will be an issue for the repo.
   
   Let me give it some more thought next week, because also there is additional overhead to create something extra.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@fluss.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org