datree icon indicating copy to clipboard operation
datree copied to clipboard

add documentation command

Open TzlilSwimmer123 opened this issue 1 year ago • 5 comments

Is your feature request related to a problem? Please describe. An easy way to open datree documentation

Describe the solution you'd like Adding documentation or docs command that will open a browser with datree documentation

TzlilSwimmer123 avatar Aug 22 '22 14:08 TzlilSwimmer123

Hey @TzlilSwimmer123, can you tell me, how we can achieve this? I want to work on this issue

Kanika637 avatar Aug 24 '22 07:08 Kanika637

Hi @Kanika637

At the moment we have some commands like: test, config, publish. My suggestion is to add a new command that user can use like datree docs or datree documentation and this command will open datree docs link in the browser. The link https://hub.datree.io/

TzlilSwimmer123 avatar Aug 24 '22 08:08 TzlilSwimmer123

@Kanika637 We are using cobra as our commands framework. We also have an already implemented function openBrowser here that opens a browser with a given url. So, what you can do is to add a new command under the root command and use the openBrowser in this command. Since this function will not be only for test package anymore, it's location could be changed to pkg/utils for example and then you can use it both for test command and pkg/utils command. WDYT?

myishay avatar Aug 24 '22 09:08 myishay

Okay, I got it ! @myishay I have to add it in cmd>root.go right?

Kanika637 avatar Aug 24 '22 12:08 Kanika637

@Kanika637 correct!

The version command can be a good hint on how to implement the file structure etc.

myishay avatar Aug 24 '22 12:08 myishay

Hi there, looks like there is no active development on this issue. I can take it up.

amustaque97 avatar Oct 02 '22 20:10 amustaque97

@Kanika637 it seems like long time passed. You will have time to develop it or we can assign another contributor?

TzlilSwimmer123 avatar Oct 03 '22 05:10 TzlilSwimmer123

Hi @TzlilSwimmer123, I am working on this issue to see if I can solve it. I have one question: the docs URL will be hardcoded or dynamic? If it is dynamic, from which place will I get the URL?

imrushi avatar Oct 18 '22 06:10 imrushi

Hi @imrushi, @amustaque97 wanted this issue, @amustaque97 do you still want it?

TzlilSwimmer123 avatar Oct 18 '22 08:10 TzlilSwimmer123

Hi @imrushi, @amustaque97 wanted this issue, @amustaque97 do you still want it?

Hey @TzlilSwimmer123, I have no issues if @imrushi wants to work on this. Please go ahead 🚀

amustaque97 avatar Oct 18 '22 09:10 amustaque97

@TzlilSwimmer123, the docs URL will be hardcoded or dynamic? If it is dynamic, from which place will I get the URL?

imrushi avatar Oct 18 '22 09:10 imrushi

So sorry for the delay, you may assign it to someone else @TzlilSwimmer123.

Kanika637 avatar Oct 18 '22 11:10 Kanika637

@imrushi as mentioned above, the URL is: https://hub.datree.io 💪

TzlilSwimmer123 avatar Oct 18 '22 11:10 TzlilSwimmer123

@imrushi how is it going?

TzlilSwimmer123 avatar Oct 30 '22 12:10 TzlilSwimmer123

Hi @TzlilSwimmer123, I have created PR but there were some changes. So I was stuck at the mocking browser for testing. It took me some time to figure it out. I have resolved it just waiting to get my PR review.

imrushi avatar Oct 30 '22 12:10 imrushi