USS for dummies appendix #4810
USS for dummies appendix #4810
Conversation
Signed-off-by: arooshlele <[email protected]>
Signed-off-by: arooshlele <[email protected]>
Signed-off-by: arooshlele <[email protected]>
ArooshLele
requested review from
1000TurquoisePogs,
DivergentEuropeans,
anaxceron and
janan07
ArooshLele
added
area: docs
|
😺 Thank you for creating this PR! To publish your content to Zowe Docs, follow these required steps.
Need help? Contact the Doc Squad in the #zowe-doc Slack channel. |
|
💾 The release label is missing. Add a If you have addressed this issue already, refresh this page in your browser to remove this comment. |
Signed-off-by: arooshlele <[email protected]>
Signed-off-by: Martin Zeithaml <[email protected]>
Signed-off-by: Martin Zeithaml <[email protected]>
|
I'm not sure if this appendix is a good idea. We flirted with writing similar guides around z/OSMF installation and configuration in the past, and in general I think we've agreed that the Zowe community should not become responsible for education on core z/OS capabilities and features. Can we instead point to IBM documentation on the topic, or write a blog on getting started with USS instead, or work with Joe W. and the IBM team to create a similar document that's owned by IBM? |
|
Agree w/ Mark. I think we (as in Zowe stakeholders) have agreed to not include documentation on basic core concepts and instead to link to other (outside) doc. But if your team does decide to go forward w/ this section, please rename it. We don't want to use "dummies" to describe our audience and, also, I think that term could imply the official Dummies guides and I don't think we want to do that. |
Thanks, Mark and Ana for the feedback. I agree with you. I edited the page's title accordingly. I am in a discussion with Sean to identify and narrow down the essentials that may have to be retained on the pages. |
|
|
||
| - [Introduction to z/OS UNIX](#introduction-to-zos-unix) | ||
| - [Getting Started with z/OS UNIX](#getting-started-with-zos-unix) | ||
| - [Zowe and z/OS UNIX](#zowe-and-zos-unix) |
There was a problem hiding this comment.
No need for this ToC as a ToC for the page is automatically generated on the right side of the page
There was a problem hiding this comment.
Agreed. I've removed the TOC.
|
|
||
| ## Introduction to z/OS UNIX | ||
|
|
||
| z/OS UNIX is an integral part of the z/OS operating system, bringing the strengths of UNIX to the powerful mainframe environment. z/OS UNIX allows you to run UNIX applications and services on a z/OS system, leveraging the robust security, scalability, and reliability features of the mainframe. It’s essential for modern enterprise applications and services, and for Zowe which leverages z/OS UNIX for various functionalities. |
There was a problem hiding this comment.
It's: we avoid contractions
There was a problem hiding this comment.
Edited to "It is"
| ## Getting started with z/OS UNIX | ||
|
|
||
| 1. Accessing the UNIX Shell: To begin, you need to access the UNIX System Services (USS) environment on your z/OS. You can do this by logging in to TSO/E and entering the OMVS command or directly through a secure shell (SSH) client. | ||
| 2. Basic Commands: Familiarize yourself with basic UNIX commands. Commands like ls, cd, pwd, mkdir, and rmdir will help you navigate and manage directories. |
There was a problem hiding this comment.
- should the commands be in backticks?
- avoid future tense
There was a problem hiding this comment.
Yes. Commands on lines 2 and 3 are now enclosed in backticks.
|
|
||
| 1. Accessing the UNIX Shell: To begin, you need to access the UNIX System Services (USS) environment on your z/OS. You can do this by logging in to TSO/E and entering the OMVS command or directly through a secure shell (SSH) client. | ||
| 2. Basic Commands: Familiarize yourself with basic UNIX commands. Commands like ls, cd, pwd, mkdir, and rmdir will help you navigate and manage directories. | ||
| 3. File Permissions: Understand the UNIX file permissions and how to modify them using the chmod command. Remember that the right permissions are crucial for the proper execution of files and directories. |
| - Zowe APIs: Zowe offers REST APIs that interact with z/OS UNIX. You can leverage these APIs to automate and integrate z/OS UNIX functionalities with other systems and services. Some APIs come from z/OSMF and some come from ZSS. | ||
| - Zowe App Framework: The Zowe Desktop has a collection of apps that interact with z/OS Unix, such as the Zowe Editor or USS Explorer. | ||
|
|
||
| ## Best Practices |
There was a problem hiding this comment.
"Practices" should be lowercase per our style guide
There was a problem hiding this comment.
Yes, it is now in lowercase.
| tso | Can be used to issue non-administrative TSO commands | ||
| vi | A builtin editor for files. Has a learning curve, use ":q!" to exit if stuck. | ||
| | | Pipe, used to forward the output (STDOUT) data from one program as input (STDIN) to another program. | ||
| && | Used to run multiple programs but only on the condition that the first succeeds (has a return code $? of 0) |
| ## How to access UNIX content from z/OS: | ||
|
|
||
| Select option 17 Udlist (Print or Display (to process) z/OS UNIX directory list). And type in some path for the directory that they want to look in. | ||
| In UNIX, data is organized in the form of files and folders, where a folder can contain more folders. And it can also contain files, so it is little bit different from datasets. |
|
|
||
| Select option 17 Udlist (Print or Display (to process) z/OS UNIX directory list). And type in some path for the directory that they want to look in. | ||
| In UNIX, data is organized in the form of files and folders, where a folder can contain more folders. And it can also contain files, so it is little bit different from datasets. | ||
| There are many restrictions on what a file or folder name can contain and how long those names can be. One of the 1st things to watch out for in UNIX because of the lack of limitations. Sometimes things can be long and can create an issue, if you are trying to access or view it on a TN 3270 screen. |
| There are many restrictions on what a file or folder name can contain and how long those names can be. One of the 1st things to watch out for in UNIX because of the lack of limitations. Sometimes things can be long and can create an issue, if you are trying to access or view it on a TN 3270 screen. | ||
| For example, if the path is very long it can go to the next row, which is problematic as you have to scroll on the screen. | ||
| You can access directories from TN 3270 screen. | ||
| UNIX Files are tagged with different encoding. It can be EBCDIC, ASCII, binary and so on. As opposed to dataset files which have the data that tells you what the encoding is. |
sidebars.js
Outdated
| { | ||
| type: "category", | ||
| label: "USS for dummies", | ||
| link: { type: "doc", id: "appendix/USS_for_dummies_appendix/USS_for_dummies_appendix" }, |
There was a problem hiding this comment.
please rename the file so we're not using the term "dummies"
Removed the Table of Contents (TOC) as it was not needed. A TOC is automatically generated on the right hand side. Signed-off-by: ArooshLele <[email protected]>
Signed-off-by: ArooshLele <[email protected]>
Enclosing commands in backticks. Signed-off-by: ArooshLele <[email protected]>
Signed-off-by: ArooshLele <[email protected]>
Edits Signed-off-by: ArooshLele <[email protected]>
Edits Signed-off-by: ArooshLele <[email protected]>
Edits Signed-off-by: ArooshLele <[email protected]>
Signed-off-by: ArooshLele <[email protected]>
Edits Signed-off-by: ArooshLele <[email protected]>
Signed-off-by: ArooshLele <[email protected]>
Signed-off-by: ArooshLele <[email protected]>
Signed-off-by: ArooshLele <[email protected]>
Signed-off-by: ArooshLele <[email protected]>
Signed-off-by: ArooshLele <[email protected]>
Signed-off-by: arooshlele <[email protected]>
Signed-off-by: ArooshLele <[email protected]>
Signed-off-by: ArooshLele <[email protected]>
Describe your pull request here:
This is a new topic and its path would be: Zowe Docs --> Reference tab --> (then in the navigation pane) --> USS for dummies
List the file(s) included in this PR:
USS_for_dummies_appendix.md
After creating the PR, follow the instructions in the comments.
CC: @gauravs-20 @ArooshLele