Documentation for the API module

[tombentley]

trafficstars

We need documentation on the api module, including typical use cases and some basic examples.

[scholzj]

Triaged on 26.5.2022: This is still something we would be interested in.

[ashutosh0022]

I am completely new to open-source and came to know, that documentation is the path to begin contributing. Can anyone help me? I will do my best.

[scholzj]

@ashutosh0022 There is a guide for contributong to the documentation: https://strimzi.io/contributing/guide/ ... so that might be the best start and if you have any questions afterwards, let us know. @PaulRMellor is our documentation guru, so I'm sure he will be able to help with most of the things as well.

[devilkiller-ag]

Can I handle this issue?

[scholzj]

I think you can -> but best to be confirmed by Paul. Some examples for inspiration should be here: https://github.com/scholzj/strimzi-api-examples

@PaulRMellor? ^^^

[devilkiller-ag]

Thank you @scholzj. I will start working on it after the comfirmation by @PaulRMellor

[PaulRMellor]

Hello @devilkiller-ag - I'm here to help.

[9avneet]

@PaulRMellor ,I want to solve this issue,but I am new to this ,so if possible can you guide me a little bit,it will be very helpful.thanks

[PaulRMellor]

Thanks @9avneet -- To get started on this issue, I would suggest taking the following steps:

1. Familiarize yourself with the Strimzi Documentation Contributor Guide, which outlines the process for contributing to the documentation.
2. Set up Git on your local machine, if you haven't already. You can find instructions on how to do this in the Strimzi Documentation Contributor Guide.
3. Get an understanding of the document structure using asciidoc, which is the markup language we use for our documentation. You can find some helpful resources on Asciidoc in the Asciidoc Writer's Guide.
4. Look at the examples @scholzj provided.
5. When you feel comfortable with the docs and how you might start documenting the examples, maybe start with a simple example to get started.

[9avneet]

Thanks @9avneet -- To get started on this issue, I would suggest taking the following steps:

1. Familiarize yourself with the Strimzi Documentation Contributor Guide, which outlines the process for contributing to the documentation.
2. Set up Git on your local machine, if you haven't already. You can find instructions on how to do this in the Strimzi Documentation Contributor Guide.
3. Get an understanding of the document structure using asciidoc, which is the markup language we use for our documentation. You can find some helpful resources on Asciidoc in the Asciidoc Writer's Guide.
4. Look at the examples @scholzj provided.
5. When you feel comfortable with the docs and how you might start documenting the examples, maybe start with a simple example to get started.

Thanks for guiding.

[PaulRMellor]

Hello @9avneet -- I just wanted to check in on this issue that you offered to take a look at. It's been a month since we last spoke about it, and I wanted to see if you had any updates or if there's anything else you need from us. Please let us know if you need any assistance or have any questions. Thanks.

[9avneet]

@PaulRMellor I am facing difficulties in starting with this,I tried to go through documentation,but as I told you in an new to open source so I am not become able to proceed with the same,if you can provide me an mentor or some initial guide will be enough ,so that I can continue with the same , thanks hope you understands.

[PaulRMellor]

It seems like this task might be more challenging than expected @9avneet . As you mentioned, you are new to open source so it might be useful for you to start with a simpler documentation task that could help you gain more experience in the project. If you read through the documentation, perhaps you could find some small update. A less complex task would allow you to gain familiarity with Strimzi's documentation processes. Additionally, you could attend a community call, where you can ask questions and receive guidance.

[SaxenaAnushka102]

Greetings @scholzj, @PaulRMellor! I'd love to work on this issue. I've previously done setup of Strimzi on a Linux VM & have a basic understanding of how the project enables Apache Kafka on Kubernetes for stream processing. Could you please share some resources that I can refer to start creating the documentation?

[scholzj]

@SaxenaAnushka102 I think looking at the steps described here might be the first step:

1. Familiarize yourself with the Strimzi Documentation Contributor Guide, which outlines the process for contributing to the documentation.
2. Set up Git on your local machine, if you haven't already. You can find instructions on how to do this in the Strimzi Documentation Contributor Guide.
3. Get an understanding of the document structure using asciidoc, which is the markup language we use for our documentation. You can find some helpful resources on Asciidoc in the Asciidoc Writer's Guide.
4. Look at the examples @scholzj provided.
5. When you feel comfortable with the docs and how you might start documenting the examples, maybe start with a simple example to get started.

[SaxenaAnushka102]

Got it, I'll go through these resources & try some examples first! Thanks @scholzj

[scholzj]

Closing after discussion with @ppatierno and @PaulRMellor. It is not really clear what the ask is and this probably cannot be contributed by someone from the outside. And at the same time, we clearly do not consider it important enough to work on it ourself.