docs: add docs about all cli commands #2983
Conversation
End-rey
requested review from
roman-khimov,
carpawell and
cthulhu-rider
as code owners
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #2983 +/- ##
=======================================
Coverage 22.88% 22.88%
=======================================
Files 785 785
Lines 58806 58810 +4
=======================================
+ Hits 13457 13460 +3
- Misses 44469 44471 +2
+ Partials 880 879 -1 ☔ View full report in Codecov by Sentry. |
I think it will be useful, the same way we check CHANGELOG and configuration files. I am sure I will forget regenerating docs. |
End-rey
force-pushed
the
1413-add-readmemd-files-to-cli-commands
branch
from
5aceda3
to
c96c7c6
Compare
Add flag to gendoc command that defines if gen tag of cobra will be printed. Signed-off-by: Andrey Butusov <[email protected]>
Do this for the same command output so that the documentation generation is the same for the command. Signed-off-by: Andrey Butusov <[email protected]>
Generate docs with `neofs-cli gendoc ./docs/cli-commands -d`. Add Makefile target for generation docs. Closes #1413. Signed-off-by: Andrey Butusov <[email protected]>
End-rey
force-pushed
the
1413-add-readmemd-files-to-cli-commands
branch
5 times, most recently
from
5df620a
to
d003143
Compare
| @@ -14,7 +14,8 @@ import ( | |||
| ) | |||
|
|
|||
| const ( | |||
| gendocTypeFlag = "type" | |||
| gendocDisableAutoGenTagFlag = "disable-auto-gen-tag" | |||
There was a problem hiding this comment.
not sure we need it, but dont mind, mb @roman-khimov has some thoughts
There was a problem hiding this comment.
I think we do because otherwise we can't have consistent output each time we run the generator.
There was a problem hiding this comment.
i meant if we need it to be possible to change via a separate command flag
End-rey
force-pushed
the
1413-add-readmemd-files-to-cli-commands
branch
from
5c5e145
to
d003143
Compare
End-rey
force-pushed
the
1413-add-readmemd-files-to-cli-commands
branch
from
b5fe96d
to
15bbd72
Compare
| - name: Fail if CLI commands files are changed but the documentation is not updated | ||
| run: | | ||
| git add -N docs/cli-commands | ||
| git diff --exit-code -- docs/cli-commands/ |
There was a problem hiding this comment.
can you add new line at the end of file, please?
Signed-off-by: Andrey Butusov <[email protected]>
End-rey
force-pushed
the
1413-add-readmemd-files-to-cli-commands
branch
from
15bbd72
to
3050baa
Compare
Generate docs with
neofs-cli gendoc ./docs/cli-commands.Closes #1413.
So, if we add a new command, should we generate docs now? Should we also add some checks so that we don't forget to do this?