Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SDK Readme Updates #4599

Merged
merged 10 commits into from
Oct 27, 2024
Merged

SDK Readme Updates #4599

merged 10 commits into from
Oct 27, 2024

Conversation

Shellyber
Copy link
Contributor

@Shellyber Shellyber commented Oct 6, 2024

Related Issues

fixes: https://jira-dc.paloaltonetworks.com/browse/CIAC-11880

Description

  • Updated the main README for the demisto-sdk
  • Updated some of the helper arguments for the commands in main
  • Updated READMEs according to the helper

@Shellyber
Copy link
Contributor Author

@samuelFain @dorschw anything more we want to add here at the moment?

@ShahafBenYakir
Copy link
Contributor

@Shellyber I think we said we want to align the -help feature with these docs as well no?

@samuelFain
Copy link
Contributor

@samuelFain @dorschw anything more we want to add here at the moment?

@Shellyber
I think it looks a lot better, the separation between of the installation and environment setup is very clear.
About docs/demisto-sdk-docker.md, is it corresponding with a page in the documentation as well? Do we plan to add more markdowns to the docs folder?

@Shellyber
Copy link
Contributor Author

@Shellyber I think we said we want to align the -help feature with these docs as well no?

Yes. I'll add the demisto-sdk flags as well to the docs here and afterward to the official docs site as well.

@Shellyber
Copy link
Contributor Author

@samuelFain @dorschw anything more we want to add here at the moment?

@Shellyber I think it looks a lot better, the separation between of the installation and environment setup is very clear. About docs/demisto-sdk-docker.md, is it corresponding with a page in the documentation as well? Do we plan to add more markdowns to the docs folder?

For the moment, the docker article does not exist on the official docs site - right now it is referred to xsoar.pan.dev page which won't be longer accessible. So I'm adding it here in the meantime.
Once I'll do the work with the docs team, we can add the article directly there, and reference from here.
But I think it is a good place to keep this article as well.
Regarding more docs, not at the moment, but it is good to have it anyway.

@Shellyber
Copy link
Contributor Author

@samuelFain @ShahafBenYakir If you can review

Copy link

Changelog(s) in markdown:

  • Update SDK documentation. #4599

@Shellyber Shellyber merged commit c66899a into master Oct 27, 2024
25 checks passed
@Shellyber Shellyber deleted the readme-updates branch October 27, 2024 11:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants