Documentation for the DGI CLI - Githubissues

konveyor / tackle-data-gravity-insights

Apache License 2.0

15 stars 12 forks source link

Documentation for the DGI CLI #4

Closed rofrano closed 1 year ago

rofrano commented 2 years ago

As a Migration Architect
I need good documentation for data gravity insights
So that I can understand how to use all of its capabilities

Details & Assumptions

We should provide documentation for the dgi CLI similar to what move2kube and forklift have done.
Move2kube is using Jekyll with the pmarsceill/just-the-docs theme and Forklift is using the jekyll-theme-cayman theme
We should decide if this should probably reside in a separate repo or if Tackle has a documentation repo we can leverage

Acceptance Criteria

Given we have good documentation
When someone needs to use dgi
Then it will be easy for them to understand how to use it

rofrano commented 2 years ago

Need to check with Tackle team because this is really Tackle level documentation