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

More comprehensive CLI dev tutorial #698

Open
BrandonJenkins14 opened this issue Sep 5, 2019 · 2 comments
Open

More comprehensive CLI dev tutorial #698

BrandonJenkins14 opened this issue Sep 5, 2019 · 2 comments
Assignees
Labels
area: cli This issue is related to Zowe Command Line Interface (CLI) area: docs Documentation issue or issues that have documentation impact area: onboarding This issue is related to overall user onboarding priority-low type: enhancement New feature or request

Comments

@BrandonJenkins14
Copy link
Contributor

@tucker01, @zFernand0 just creating this issue to note our idea of improving the CLI dev tutorials.

As a CLI plug-in developer, I want to read a single document that introduces me to the development resources and walks me through the major steps from new idea to built and delivered plug-in. Current tutorials focus on adding commands and creating your first standalone plug-in.

We could improve by adding information about:

  • Planning your plug-in (considering cli use cases, command naming, dev tools and skills that you should already have before getting started, etc...)
  • Information about developing the API portion of code.
  • When, how, and why to submit for Zowe Conformance
  • Information about getting your plug-in into the Zowe Jenkins builds, other administrative tasks to publish and advertise your plug-in.
  • Advice for maintaining your plug-in as part of a community.
@BrandonJenkins14 BrandonJenkins14 added type: enhancement New feature or request area: docs Documentation issue or issues that have documentation impact labels Sep 5, 2019
@BrandonJenkins14 BrandonJenkins14 self-assigned this Sep 5, 2019
@nannanli nannanli added the area: cli This issue is related to Zowe Command Line Interface (CLI) label Sep 17, 2019
@BrandonJenkins14
Copy link
Contributor Author

Consider: We have 2 versions of the tutorial, one in "Stable" and one in "Active Development" doc. Currently, the only difference is which branch is to be cloned and whether to use @Brightside or @zowe dependencies.

We might want to explain developing for both versions in a more linear way, rather than the current setup where you follow one version of the tutorial then the other. Potentially confusing.

@zFernand0
Copy link
Member

zFernand0 commented Oct 3, 2019

@JamesBauman, @BrandonJenkins14, How about migrating/merging the tutorial with the corresponding branches (on the sample-plugin) for Active Development (master) and Stable (lts-incremental)?

@JTonda JTonda added area: onboarding This issue is related to overall user onboarding priority-low and removed for-review labels Nov 30, 2022
@github-project-automation github-project-automation bot moved this to New Issues in Zowe CLI Squad Jan 8, 2024
@t1m0thyj t1m0thyj moved this from New Issues to Low Priority in Zowe CLI Squad Jan 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: cli This issue is related to Zowe Command Line Interface (CLI) area: docs Documentation issue or issues that have documentation impact area: onboarding This issue is related to overall user onboarding priority-low type: enhancement New feature or request
Projects
Status: Low Priority
Development

No branches or pull requests

5 participants