Doc BUGs – an easy way to contribute Open Source project(part-1)

In this topic I would like to make some notes about questions, how we can contribute or help on Open Source project.
The first thing is, to learn the product itself, how to install, how to remove, how to use etc.
Of course, the first place for this information is an official documentation.
How you can use the DOC? I am taking following approach:
* Read the doc to learn the needed thing.
* Test the info provided in the DOC –
if the info is valid(i.e you have different results)
if it is not valid:
Report a bug – then continue reading.

The issue can be in DOC itself or in the product.
Did you find small typo in DOC? Did you think some info about topic is wrong? Or maybe you found wrong code samples?
Report it immediately and you will be the part of community.

Let’s take some DOC bug reports and examine them to get the idea.
The first is -> #87545:
While reading Connector/Python X Plugin reference did not see any info about Error module(mysqlx.errors).
So this missing info must be there, that is why reported as described. Simple? But it is crucial.

Another one is -> #81036
There is an entry about:
“Installing MySQL Shell on Yum-based Systems”:

> Install MySQL Shell with this command:

sudo apt-get install mysql-shell

Well you have already noticed that, it must be yum command not apt. Funny? But it is needed.

Another one -> #80801

So basically here, I read the doc, run the given SQL and did not get result, then figured out that, the sample SQL was wrong and reported as described in report.

Here -> #88861
There is a typo on ALGORITM word in some places. Silly? But verified 🙂

Let’s examine the last one -> #88464

Here, I saw the error message in 5.7 but read about this only in 8.0 versions DOC. So the same info should be in 5.7s DOC as well, because I see error on 5.7 too.

In conclusion, we should understand the importance of documentation as well as, the importance to report DOC issues.
Many things are happening because of misunderstanding DOC or because of wrong info inside the DOCs.

Think about this twice in the next time, when you find some weird thing in DOC and just ignore it.
It is a real life, the thing which is not crucial for us can be important for others.

Thanks for reading.

Author: Shahriyar Rzayev

Azerbaijan MySQL User Group and Python user group leader. QA Engineer, bug hunter by nature and true Pythonista

Leave a Reply

Fill in your details below or click an icon to log in: Logo

You are commenting using your account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

This site uses Akismet to reduce spam. Learn how your comment data is processed.