[hotfix] [docs] Link documentation contribution guide from CONTRIBUTING#27802
Open
lurui1997 wants to merge 1 commit intoapache:masterfrom
Open
[hotfix] [docs] Link documentation contribution guide from CONTRIBUTING#27802lurui1997 wants to merge 1 commit intoapache:masterfrom
lurui1997 wants to merge 1 commit intoapache:masterfrom
Conversation
Author
|
Submitted as a |
Collaborator
snuyanzin
reviewed
Mar 22, 2026
|
|
||
| Please check out the [How to Contribute guide](https://flink.apache.org/contributing/how-to-contribute.html) to understand how contributions are made. | ||
| A detailed explanation can be found in our [Contribute Code Guide](https://flink.apache.org/contributing/contribute-code.html) which also contains a list of coding guidelines that you should follow. | ||
| Documentation-only changes are described in the [Documentation Contribution Guide](https://flink.apache.org/how-to-contribute/contribute-documentation/) (including how to build and preview docs under `docs/`). |
Contributor
There was a problem hiding this comment.
didn't get what is the reason to have it separate?
The link above
Please check out the How to Contribute guide to understand how contributions are made.
leads to the page with all kinds of contributions including documentation, site, code, code review etc...
If we add it here then finally we will come up to just a copy of that page in this place
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
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.
What is the purpose of the change
Point new contributors from
.github/CONTRIBUTING.mdto the official Documentation Contribution Guide so doc-only work (preview underdocs/, JIRA expectations) is discoverable next to the code contribution links.Brief change log
Verifying this change
This change is a trivial rework / code cleanup without any test coverage.
Does this pull request potentially affect one of the following parts:
Documentation
Made with Cursor