demisto / content-docs

Demisto Content Developer Docs
https://xsoar.pan.dev/
MIT License
41 stars 59 forks source link

Issue with "Demisto SDK" in @site/docs/concepts/demisto-sdk.md #921

Closed dannyjea closed 2 years ago

dannyjea commented 2 years ago

Describe the problem

I have just set up a new Windows machine with updates, installed Python, installed MS Visual Studio Code, the Python extension and I go to do the final step of install demisto-sdk, at which point the documentation tells me I should have set all this up on Linux. I appreciate I could use WSL but this adds additional complexity that I am trying to avoid.

Since demisto-sdk is a key element and is recommended to run on macOS or Linux, can you add a note higher in the documentation set to prevent wasted time.

Screenshots

Environment

Suggested fix

Since demisto-sdk is a key element and is recommended to run on macOS or Linux, can you add a note higher in the documentation set to prevent wasted time.

welcome[bot] commented 2 years ago

Hi and welcome to our Content Developer Docs project! Thanks and congrats for opening your very first issue. If you know the fix, you may also submit a PR to fix the issue if you like!

Itay4 commented 2 years ago

@dannyjea the WSL prerequisite is in the first paragraph in https://xsoar.pan.dev/docs/concepts/demisto-sdk#installation-and-setup which is at the top of the document also, it is in the contribution requirements

where else do you expect to see it?

dannyjea commented 2 years ago

Hi

Thanks for the response, on the web page https://xsoar.pan.dev/docs/concepts/xsoar-ide under developing the demisto-sdk page is listed last after Cortex XSOAR IDE, PyCharm IDE, VSCode extension and dev set up. By the time I reached the demisto sdk document page I had already set up a Windows environment, if the info about SDK could be added to the cortex xsoar ide page (or some other solution) I would have started my setup using Linux. Hope that makes sense.

Regards Danny

Get Outlook for Androidhttps://aka.ms/ghei36


From: Itay Keren @.> Sent: Sunday, January 9, 2022 6:41:05 PM To: demisto/content-docs @.> Cc: dannyjea @.>; Mention @.> Subject: Re: [demisto/content-docs] Issue with "Demisto SDK" in @site/docs/concepts/demisto-sdk.md (Issue #921)

@dannyjeahttps://github.com/dannyjea the WSL prerequisite is in the first paragraph in https://xsoar.pan.dev/docs/concepts/demisto-sdk#installation-and-setup which is at the top of the document also, it is in the contribution requirementshttps://xsoar.pan.dev/docs/contributing/contrib-requirements#development-os

where else do you expect to see it?

— Reply to this email directly, view it on GitHubhttps://github.com/demisto/content-docs/issues/921#issuecomment-1008246187, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AU47P3EXBNZJGIYRXB2LZT3UVE3ZDANCNFSM5LNXHDZQ. Triage notifications on the go with GitHub Mobile for iOShttps://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Androidhttps://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub. You are receiving this because you were mentioned.Message ID: @.***>

Itay4 commented 2 years ago

the Cortex XSOAR IDE and the PyCharm IDE Plugin do not require the Demisto SDK, but do refer to the VSCode Extension, which one of its prerequisites is the Demisto SDK and refers to the page i mentioned in my previous comment - did you miss that ?

dannyjea commented 2 years ago

Probably, I will take another look. Thanks for your support.

Regards Danny

Get Outlook for Androidhttps://aka.ms/ghei36


From: Itay Keren @.> Sent: Sunday, January 9, 2022 9:07:05 PM To: demisto/content-docs @.> Cc: dannyjea @.>; Mention @.> Subject: Re: [demisto/content-docs] Issue with "Demisto SDK" in @site/docs/concepts/demisto-sdk.md (Issue #921)

the Cortex XSOAR IDE and the PyCharm IDE Plugin do not require the Demisto SDK, but do refer to the VSCode Extension, which one of its prerequisites is the Demisto SDK and refers to the page i mentioned in my previous comment - did you miss that ?

— Reply to this email directly, view it on GitHubhttps://github.com/demisto/content-docs/issues/921#issuecomment-1008267336, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AU47P3GQ4ZPHJ3A62LGBC5TUVFM4TANCNFSM5LNXHDZQ. Triage notifications on the go with GitHub Mobile for iOShttps://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Androidhttps://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub. You are receiving this because you were mentioned.Message ID: @.***>

Itay4 commented 2 years ago

sure no problem 👍

if you don't mind, i'm gonna close this one for now

feel free to reopen it or open a new issue if you have a suggestion on how we can improve our documentation