Introduction
This is my first contribution to the flyte source project. I have completed two PRs for this opensource project, both on documentations. This is a Production-grade project, which has been deployed in large companies such as lyft. Thus, I have learnt a lot through making my contributions, reading the documentation and communicating with the project maintainers.
Project
I chose the flytekit project, which is one of the component repos of flyte and is the python SDK and tools of the Flyte project. The flykit project was written in python and is also production-grade project. The documentation was generated using Sphinx documentation in .rst format.
Issue
The issue was raised here. The first part of the issue is to check all doc files in https://github.com/flyteorg/flyte/tree/master/rsts, and https://github.com/flyteorg/flytekit/tree/master/docs.
Challenge
The most challenge part of this issue was to precised locate the problem.
Solution and Pull Request
To target the locations of problem precised and efficiently, several search methods were used. For this PR and commit, there are not too many doc files in this case. Thus, the search engine on GitHub webpage is adequate.
Top comments (0)