Hi Ivan, Thanks for sharing the information. I'll look through the docs and share my thoughts and suggestions soon.
Regards, Nikita пт, 23 апр. 2021 г. в 14:06, Ivan Daschinsky <ivanda...@gmail.com>: > Hi, Nikita! Thanks for support. > > As developers of thin client, we also would try to update > documentation as soon as possible. > For example, recently I've merged to master expiry policy support for > python thin client and documentation was updated simultaneously [2][3] > > I am planning to update documentation frequently and I would > appreciate any feedback about our current documentation on > readthedocs.io > > > [1] -- https://issues.apache.org/jira/browse/IGNITE-14595 > [2] -- > https://apache-ignite-binary-protocol-client.readthedocs.io/en/latest/examples.html#expirypolicy > [3] -- > https://apache-ignite-binary-protocol-client.readthedocs.io/en/latest/async_examples.html#expirypolicy > > > > пт, 23 апр. 2021 г. в 13:29, Никита Сафонов <vlasovpavel2...@gmail.com>: > > > > Hi Ivan, > > > > Thank you for the suggestion. > > > > I agree that Ignite main docs on thin clients probably need a clean-up to > > be kept up-to-date. > > And migrating the key information to readthedocs.io is really an option. > > > > Let's see what other Igniters think about this idea. > > > > I'd be glad if Igor Gusev could share his opinion on this. > > > > Regards, > > Nikita > > > > > > > > чт, 22 апр. 2021 г. в 22:15, Ivan Daschinsky <ivanda...@apache.org>: > > > > > Igniters, there are some questions regarding the documentation state > > > of thin clients. > > > > > > Recently, we have released pyignite 0.4.0. Traditionally, > > > documentation for python thin client is autogenerated from source and > > > contains in the same git repository, as the client itself. > > > Documentation is autogenerated and hosted in familiar for python > > > developers manner -- on readthedocs.io (Namely, > > > https://apache-ignite-binary-protocol-client.readthedocs.io/en/latest/ > ) > > > > > > I suppose the same statement is true for other separately developed > > > clients (nodejs, php). > > > > > > So I'd like to discuss a current documentation approach for thin > clients. > > > 1. I strongly believe that the main documentation site for at least > > > python thin client should be readthedocs.io. > > > 2. Documentation should be maintained in the same repository as the > > > thin client itself. > > > 3. As the main documentation's version is tightly coupled with ignite > > > release cycle, it is by default outdated and doesn't resemble the > > > latest version of thin client. > > > > > > I suggest just remove all documentation from the main docs except > > > simple installation instruction (i.e. pip install pyignite) and link > > > to readthedocs.io > > > > > > Regards, Ivan Daschinsky > > > > > > > -- > Sincerely yours, Ivan Daschinskiy >
