[docs] add contribute a blog post guide (#3180)#3182
Open
tmchow wants to merge 1 commit intoapache:mainfrom
Open
[docs] add contribute a blog post guide (#3180)#3182tmchow wants to merge 1 commit intoapache:mainfrom
tmchow wants to merge 1 commit intoapache:mainfrom
Conversation
Creates website/community/how-to-contribute/contribute-blog-post.md so the community documentation explains how to author a post for the Fluss blog (https://fluss.apache.org/blog) alongside the existing code and documentation contribution guides. Content is adapted from the apache/fluss-blog README workflow the issue points at, expanded with an "open an issue first" step to match Fluss's existing contribution process. Closes apache#3180
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Contribution Checklist
[component] Title([docs]).Purpose
Closes #3180.
Community members asked for a clear guide on how to contribute blog posts to https://fluss.apache.org/blog. The existing
how-to-contributesection covers code and documentation contributions but is silent on blog submissions, which live in a separate repository (apache/fluss-blog) and use a slightly different workflow from the main docs. Without this guide, new contributors have to read the fluss-blog README, infer the convention, and reverse-engineer how it fits the project's broader contribution process.This adds
website/community/how-to-contribute/contribute-blog-post.mdthat walks a contributor from topic proposal to publication. Content is adapted from the apache/fluss-blog README the issue references, with an explicit "open an issue first" step prepended so blog submissions follow the same discuss-first discipline as code and docs contributions in this repo. The existing sibling pages (contribute-code.md,contribute-docs.md,review-pull-requests.md,bug-reports-feature-requests.md) all usesidebar_position: 1and let Docusaurus sort alphabetically inside the category, so the new file uses the same position and lands betweenbug-reports-feature-requestsandcontribute-codeas expected.Brief change log
website/community/how-to-contribute/contribute-blog-post.mdcovering: propose the topic, fork and clone apache/fluss-blog, repository layout, write the post (filename, frontmatter, images, authors, tags), local preview, and submission/publication flow.Tests
Not applicable (docs-only). Verified locally with
npm install && npm run buildinwebsite/. The two pre-existing broken-link errors on/downloads/->/blog/releases/0.8/|0.9/and/->/docs/quickstart/flink/are unrelated to this change. The new page itself does not introduce any broken references.API and Format
Not applicable.
Documentation
This pull request is documentation-only.