[
https://issues.apache.org/jira/browse/IGNITE-15410?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Andrey N. Gura updated IGNITE-15410:
------------------------------------
Description:
Internal documentation for {{cli}} module which represented by
{{modules/cli/README.md}} file is obsolete.
It seems that internal documentation of {{cli}} module should be developer
oriented and should not consist of list of possible commands. Instead it should
describe module design and 'How to' sections which describe how new commands,
arguments, etc could be added.
Also it makes sense to add reference to user oriented document which describes
Ignite CLI commands: {{docs/_docs/ignite-cli-tool.adoc}}
was:
Internal documentation for {{cli}} module which represented by
{{modules/cli/README.md}} file is obsolete.
It seems that internal documentation of {{cli}} module should be developer
oriented and should not consist of list of possible commands. Instead it should
describe module design and 'How to' sections which describe how new commands,
arguments, etc could be added.
> CLI: cli module internal documentation is obsolete
> --------------------------------------------------
>
> Key: IGNITE-15410
> URL: https://issues.apache.org/jira/browse/IGNITE-15410
> Project: Ignite
> Issue Type: Bug
> Reporter: Andrey N. Gura
> Priority: Major
> Labels: ignite-3, internal-doc
>
> Internal documentation for {{cli}} module which represented by
> {{modules/cli/README.md}} file is obsolete.
> It seems that internal documentation of {{cli}} module should be developer
> oriented and should not consist of list of possible commands. Instead it
> should describe module design and 'How to' sections which describe how new
> commands, arguments, etc could be added.
> Also it makes sense to add reference to user oriented document which
> describes Ignite CLI commands: {{docs/_docs/ignite-cli-tool.adoc}}
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
