search

zeromq / czmq

High-level C binding for ØMQ
czmq.zeromq.org
Mozilla Public License 2.0
1.19k stars 526 forks source link

No online documentation? #1563

Closed jtanx closed 7 years ago

jtanx commented 7 years ago

Version 4 has been marked as stable, but I don't see any online documentation on this API. Am I missing something here?

Thanks!

bluca commented 7 years ago

The documentation in the main landing page of the repo applies: https://github.com/zeromq/czmq

But yes czmq.zeromq.org should be updated. Unfortunately I do not have permissions to do so. @sappo any idea how we can update that site?

sappo commented 7 years ago

I don't have the permissions either. Maybe @somdoron does.

squidfunk commented 7 years ago

The release management is horrible. The new APIs (especially the zactor_t is pretty cool), but without any detailed documentation I'm not able to use it in production.

sappo commented 7 years ago

Hi @squidfunk, all details about the czmq API can be found in the README.md online https://github.com/zeromq/czmq/blob/master/README.md and on the released tarballs as well. Also there is a man page man zactor which contains the same information.

squidfunk commented 7 years ago

@sappo The problem is with all those API changes that my code doesn't run anymore as it depended on zthread. I managed to get the proxy to tun, but not my worker infrastruture. The docs on zactor and zloop are not very good, I cannot find much information, even here in the README. For example it states that an actor must call zsock_signal, but no reference in the example on how/where etc.

sappo commented 7 years ago

Okay, I see. There is another section that might help https://github.com/zeromq/czmq#toc2-8450 including a template on how to implement an actor.

squidfunk commented 7 years ago

Thanks, I will look into it!

sappo commented 7 years ago

@squidfunk if this is not enough, please open another ticket i.e. "Improve zactor documentation" and then we can discuss what is missing to guide beginners to learn the zactor api quickly :)

bluca commented 7 years ago

@sappo you regenerated the zguide right? Any chance you could do the same for the CZMQ website given you are familiar with the tools?

sappo commented 7 years ago

@bluca I'm able to regenerate the guide. But I couldn't publish it as I don't have access to the wikidot zguide wiki and neither the czmq wikidot wiki. I request a new wiki for the zguide but the wikidot folks are not very responsive.

bluca commented 7 years ago

Ah I see. If it's not too much hassle could you please request a new one for CZMQ too?

somdoron commented 7 years ago

@sappo @bluca I'm trying to get control for those websites. Maybe we can transform them to work on gitbook, someone already did it for rfc.zeromq.org, so it might be easier, I will try to find who.

somdoron commented 7 years ago

@yrashk how hard will it be to use gitbook with czmq and zguide?

sappo commented 7 years ago

@somdoron czmq should be fairly simple as we already have a markdown representation namely README.md. The zguide is a different beast, I tried the migrate it to Pieter's latests publishing tool mkbook but it does not support images or code snippets which are required for the guide. Porting the zguide is a lot of work.

somdoron commented 7 years ago

@sappo so for now can we host the czmq documentation of gitbook? I can change the DNS. @yrashk did it and already have some experience.

sappo commented 7 years ago

It will be a copy of the github landing page in gitbook style, but yes!

somdoron commented 7 years ago

@sappo @bluca you should have an invitation on wikidot to the czmq and zguide. Please confirm and let me know when you joined.

sappo commented 7 years ago

ACK

bluca commented 7 years ago

Got it, thanks!

bluca commented 7 years ago

Fixed by @sappo - thanks!

http://czmq.zeromq.org/