- Notifications
You must be signed in to change notification settings - Fork3.6k
-
Is your feature request related to a problem? Please describe.Hello, I've been using this repository and find it very useful. However, I've noticed that the documentation could be improved to better assist new users and developers. Describe the solution you'd likeSpecifically, I believe the following areas could benefit from more detailed documentation:
Describe alternatives you've consideredNo response Additional contextNo response |
BetaWas this translation helpful?Give feedback.
All reactions
Replies: 2 comments 6 replies
-
Hello! Thanks for using the tutorials. I have converted your issue to a discussion as we prefer to use discussions to, well, discuss things before actual work is done. As you've seen,ALL of the software and documentation you are using are open-source, and available to you for free. Team RabbitMQ would appreciate it if you took the time to improve the documentation yourself. In your specific case, it would be helpful to know the following:
|
BetaWas this translation helpful?Give feedback.
All reactions
-
Hello. I am using Rust. Specifically using the |
BetaWas this translation helpful?Give feedback.
All reactions
-
Documentation usually consists of three parts:
RabbitMQ has tutorials for more than 10 programming languages, more detailed guides for Java and .NET clients, and general language-neutral guides likePublishers andConsumers. API reference is also available for Java and .NET, and the client API surface is so small that arguably they do not add that much value, except for a couple of functions (to publish and register a consumer). Our team does not have the resources to produce similar doc guides for 10+ client libraries but all docs are open source and everyone is welcome to contribute them. Note that we will apply the same quality and completeness standards for anything we put out there on rabbitmq.com but for clients such as Pika or amqplib (Node.jS), the docs usually reside in their respective repositories and have different standards and structure. |
BetaWas this translation helpful?Give feedback.
All reactions
👍 1
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
-
I understand that providing docs for all languages supported is no easy task. I was asking if the API documentation for Rust could be improved |
BetaWas this translation helpful?Give feedback.
All reactions
-
I suggest asking the |
BetaWas this translation helpful?Give feedback.
All reactions
👍 2
-
We do not maintain Lapin. In fact, some members of our team strongly prefer and have contributed to a different Rust client:https://github.com/gftea/amqprs. Both clients are open source, so if something is lacking, it can be added by their respective user communities. This is open source software after all, not "free labor" software. |
BetaWas this translation helpful?Give feedback.
All reactions
-
Thanks. Realized that lapin isn't maintained by you guys. Sorry about that@lukebakken@michaelklishin. The Rust tutorial on the site could be improved though. I know its not free labour but it would really help Rust devs everywhere |
BetaWas this translation helpful?Give feedback.
All reactions
-
Will look at it. Many thanks |
BetaWas this translation helpful?Give feedback.
All reactions
This discussion was converted from issue #380 on March 20, 2024 15:51.