Skip to content

[hotfix] [docs] Link documentation contribution guide from CONTRIBUTING#27802

Open
lurui1997 wants to merge 1 commit intoapache:masterfrom
lurui1997:hotfix/docs-contributing-guide-link
Open

[hotfix] [docs] Link documentation contribution guide from CONTRIBUTING#27802
lurui1997 wants to merge 1 commit intoapache:masterfrom
lurui1997:hotfix/docs-contributing-guide-link

Conversation

@lurui1997
Copy link

What is the purpose of the change

Point new contributors from .github/CONTRIBUTING.md to the official Documentation Contribution Guide so doc-only work (preview under docs/, 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:

  • Dependencies: no
  • The public API: no
  • The serializers: no
  • The runtime per-record code paths: no
  • Deployment or recovery: no
  • The S3 file system connector: no

Documentation

  • Does this pull request introduce a new feature? no

Made with Cursor

@lurui1997
Copy link
Author

Submitted as a [hotfix] [docs] change per .github/PULL_REQUEST_TEMPLATE.md (no JIRA for trivial doc onboarding tweaks). Happy to fold into a FLINK ticket if a committer prefers.

@flinkbot
Copy link
Collaborator

flinkbot commented Mar 22, 2026

CI report:

Bot commands The @flinkbot bot supports the following commands:
  • @flinkbot run azure re-run the last Azure build


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/`).
Copy link
Contributor

@snuyanzin snuyanzin Mar 22, 2026

Choose a reason for hiding this comment

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

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

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.

3 participants