Hi Kewei,

Welcome to the community and contributing!

Normally, for fixes that apply only to specific release branches, you can 
simply open a pull request against that branch, and not against master branch.
For example, to fix something for Flink 1.3.x, open a pull request against the 
`release-1.3` branch.

I agree that we should perhaps update that part of the contribution doc guide a 
bit for these cases.

Cheers,
Gordon

On 22 September 2017 at 12:16:03 PM, Kewei Shang (keweish...@gmail.com) wrote:

Hi, 

I'm new to Flink documentation contribution. 

I've noticed there is a typo error in the lastest stable version of 
documentation, which makes a File not found error when linking to another 
page: 
https://ci.apache.org/projects/flink/flink-docs-release-1.3/ 


The lastest Flink documentation v1.4-SNAPSHOT ( 
https://ci.apache.org/projects/flink/flink-docs-release-1.4/) doesn't have 
this typo error. 
Only the flink-docs-release-1.3 has this typo error. 

I've read the Contribute Documentation page here: 
https://flink.apache.org/contribute-documentation.html 

But I still have some questions in the steps I should follow before I 
start. Here are the steps and my questions: 
1. Make sure no corresponding JIRA already existed, then create a JIRA. 
2. Fork Flink project and clone my fork to my machine. 
3. Create a branch related to JIRA. 
Question: Based on which branch should I create my branch? The error 
exists only on branch release-1.3, not on branch master. 
4. Make changes, test, and push changes to my fork. 
5. Create Pull Request. 
Question: The contribute-documentation guide says "Make sure that the 
base fork is apache/flink master", but since the typo exists only on branch 
release-1.3, not on branch master, should I still choose apache/flink 
master as base fork? If not, which base fork shall I choose? 

Thank you. 

Kind regards, 
Kewei Shang 

Reply via email to