The Konveyor project would like to develop documentation showing users how to leverage Konveyor for solving a wide number of use-cases.
One of the issues we see in the community is that new adopters may not realize the potential of how/where they can leverage Konveyor. We intend to help with this problem by building a number of guided scenarios, documentation with examples that a user may run through such as a 'getting started guide' tailored to specific use-cases.
This specific issue is for us to track how we can do the work on the Maintainer side to arm new contributors to help us with this documentation effort.
The rough idea is that as maintainers we will:
Choose a few use-cases we believe will be of interest to adopters
Create a tracking issue and a getting-started doc for each use-case to guide a new contributor, and label with 'good first issue'
Provide assistance to the new contributor for questions as they work through learning Konveyor and use Konveyor to solve that use-case
Provide assistance to the new contributor for blog post creation, perhaps jointly collaborating on the writing together with a Konveyor developer
Help with publishing the documentation in our docs site, and/or publishing a blog post if applicable
For each target scenario we are imagining:
Tracking issue, so a new contributor may ask questions and be assigned, or sub-issues may be broken out and tracked so multiple contributors may work together
A Konveyor community member will own creation of a getting-started document that captures background knowledge of the problem domain, links to technologies involved, recommend sample application characteristics, analysis rules needed, etc
In addition the Konveyor community member will create an outline of what they imagine the scenario should entail when it is written up.
A Konveyor community member will volunteer as a sponsor for this work and as such will help to mentor a new contributor to pickup this issue and work.
The intent is to create enough guide rails for the new contributor so they have a clear path of:
Understand what technologies to learn to achieve the scenario
Understand what pieces of Konveyor to leverage and how to accomplish the scenario
Have a rough idea of what is expected in the scenario so they have guidance of how to document this scenario
Know how to contact other community members in Konveyor to ask for guidance and help with learning more
We are considering this work to be a great way for new contributors to dive into Konveyor and learn an area by gaining real-world exposure to solving an end user need. As they learn the specific area of interest and gain user empathy, the will share their learnings via documentation to aid other users to ramp up quickly in using Konveyor....with this knowledge the contributor gains, they will set themselves up to dive deeper into interest areas for code contributions. (The thought is this helps to solve one of the more challenging aspects of how to contribute in a new domain without understanding how the solution is used by an end user.)
Is there an existing issue for this?
Konveyor version
n/a
Description
The Konveyor project would like to develop documentation showing users how to leverage Konveyor for solving a wide number of use-cases.
One of the issues we see in the community is that new adopters may not realize the potential of how/where they can leverage Konveyor. We intend to help with this problem by building a number of guided scenarios, documentation with examples that a user may run through such as a 'getting started guide' tailored to specific use-cases.
This specific issue is for us to track how we can do the work on the Maintainer side to arm new contributors to help us with this documentation effort.
The rough idea is that as maintainers we will:
For each target scenario we are imagining:
The intent is to create enough guide rails for the new contributor so they have a clear path of:
We are considering this work to be a great way for new contributors to dive into Konveyor and learn an area by gaining real-world exposure to solving an end user need. As they learn the specific area of interest and gain user empathy, the will share their learnings via documentation to aid other users to ramp up quickly in using Konveyor....with this knowledge the contributor gains, they will set themselves up to dive deeper into interest areas for code contributions. (The thought is this helps to solve one of the more challenging aspects of how to contribute in a new domain without understanding how the solution is used by an end user.)
Additional Information
No response