Denis,
OK for the legacy docs.
Agree for the core docs (specs, common getting started, etc.).
But who/what does mandate that for totally all Ignite related docs?
Why do not follow an approach which many technologies/products follow? -
maintain a centralized list of references to different client libs/SDKs
(sometimes even alternative libs for the same language/platform).
It is possible to mention a "status" of every lib - is it "verified"
(fully tested, fully documented, etc.) or just a prototype...
And it is not mandated that every lib must be developed/released under
Apache...
The list could already have references to:
- java client
- .net client
- node.js client (as early access)
- Go client by Aleksandr S. (as prototype)
- Python client by Sergey K. (as prototype)
With this approach the docs naturally come together with a concrete
client, but may be cross-referenced on readme.io for some clients as well...
-Alexey
12.05.2018 6:37, Denis Magda пишет:
Alexey,
Presently, Ignite hosts all the docs in readme.io without exception. It
means that once your contribution is accepted by the community the Node.JS
docs should be placed on readme.io.
You're right saying that we're planning to migrate from readme.io to
another documentation engine that would allow us storing doc sources in
Ignite repo. It might happen by 2.6 or might take longer.
Thus, we need to host the Node.JS docs on readme.io and edit them there
once your pull-request is merged (it means there wouldn't be docs' copy
added to Ignite repo for now). It's easy to move the docs to readme.io
which understands the standard markdown. I'll ask Prachi to assist here.
--
Denis
On Fri, May 11, 2018 at 1:45 PM, Alexey Kosenchuk <
alexey.kosenc...@nobitlost.com> wrote:
Denis,
As for the docs, are you ready to bring them to readme.io? Just let me
know
and I'll be happy to arrange an account for you and discuss the
structure.
I remember some discussion regarding moving the docs from readme.io to
GitHub pages in 2.6.
No?
In any case, in my opinion, a readme near the code is a right primary
place for the docs for thin clients.
Is there any script/automation to convert .md to readme.io?
Or maybe just place a link from the readme.io to the repo readme?
Manual support of the same docs in two places seems not an effective
solution.
The docs for NodeJS client is ready for review in the repo.
The links and the installation procedure will have to be updated when the
client is integrated into the apache repo and released on npmjs.
-Alexey
