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

Create a "CLI Quick Start" guide #374

Closed
5 tasks done
BrandonJenkins14 opened this issue Feb 12, 2019 · 2 comments
Closed
5 tasks done

Create a "CLI Quick Start" guide #374

BrandonJenkins14 opened this issue Feb 12, 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

Comments

@BrandonJenkins14
Copy link
Contributor

BrandonJenkins14 commented Feb 12, 2019

Create "Getting Started with Zowe CLI" content for advanced users who are already familiar with modern CLI tools and scripting (These users likely need minimal guidance). Content should link to core doc for more info on each topic.

New content will have the the following at minimum:

  • Install - Lightweight download and install instructions.
  • Usage - Describe the various places the CLI is used. Command Terminals, IDEs, Scripts, automation servers.
  • Issuing your first command - Show how to issue a command to list datasets from a native terminal like cmd prompt or a bash terminal on Linux/mac without using profiles.
  • Using profiles to store command options - Briefly explain the concept of profiles and show creation of a z/OSMF profile
  • Scripting - Write a shell script that submits JCL that exists in a PDS member on the mainframe and waits for the job to complete before returning the results to screen.

I suggest creating a new section under Getting Started named "Get started with Zowe CLI" or similar topic in the Using section. We can add more advanced topics iteratively (write a gulp task to perform builds, automate mainframe system tests with console commands/mochajs, create a Jenkins stage for mainframe).

Tasks

@BrandonJenkins14 BrandonJenkins14 added area: docs Documentation issue or issues that have documentation impact area: cli This issue is related to Zowe Command Line Interface (CLI) labels Feb 12, 2019
@JamesBauman
Copy link
Collaborator

@BrandonJenkins14 - in what branch are you working?

@BrandonJenkins14
Copy link
Contributor Author

@JamesBauman When we pull it into a sprint (probably next sprint) I will create a new branch off master for the work. Right now, all I have is the plan.

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
Projects
None yet
Development

No branches or pull requests

2 participants