first edits to ReadMe #2385
Open
first edits to ReadMe #2385
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: anaxceron <ana.ceron@broadcom.com>
anaxceron
added
documentation
cli
release-current
|
📅 Suggested merge-by date: 12/25/2024 |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2385 +/- ##
==========================================
- Coverage 91.28% 91.27% -0.01%
==========================================
Files 638 638
Lines 18146 18146
Branches 3915 3807 -108
==========================================
- Hits 16564 16563 -1
- Misses 1581 1582 +1
Partials 1 1 ☔ View full report in Codecov by Sentry. |
anaxceron
commented
Dec 12, 2024
anaxceron
commented
Dec 12, 2024
Signed-off-by: anaxceron <ana.ceron@broadcom.com>
…into anax-update-readme
Signed-off-by: anaxceron <ana.ceron@broadcom.com>
Signed-off-by: anaxceron <ana.ceron@broadcom.com>
zFernand0
reviewed
Dec 12, 2024
| Zowe CLI requires NPM version 8 and Cargo version 1.72.0 (or newer) to build from source. Before proceeding, check your NPM version with `npm --version` and if it's older than 8.x, update with `npm install -g npm`. To check your version of Cargo, run `cargo --version`. Cargo can be installed using rustup: [https://rustup.rs/](https://rustup.rs/). To update Cargo, run the `rustup update` command. | ||
| ## Building Zowe CLI from source | ||
|
|
||
| Zowe CLI requires NPM version 8 and Cargo version 1.72.0 (or newer) to build from source. |
There was a problem hiding this comment.
Should we say NPM version corresponding to (or bundled with) the active LTS versions of NodeJS?
That way we don't have to update this every other year 😋
|
|
||
| Check your NPM version with `npm --version` and if it's older than 8.x, update with `npm install -g npm`. | ||
|
|
||
| Check your vCargo version with `cargo --version`. Cargo can be installed using [rustup](https://rustup.rs/). To update Cargo, run the `rustup update` command. |
There was a problem hiding this comment.
Suggested change
| Check your vCargo version with `cargo --version`. Cargo can be installed using [rustup](https://rustup.rs/). To update Cargo, run the `rustup update` command. | |
| Check your Cargo version with `cargo --version`. Cargo can be installed using [rustup](https://rustup.rs/). To update Cargo, run the `rustup update` command. |
| If you try to use Zowe CLI functionality and you get an error message that Zowe CLI failed to load any profiles, try issuing the following commands: | ||
|
|
||
| - `zowe config edit` to open your `~/.zowe/zowe.config.json` configuration file in your system's default text editor. Fix any properties with incorrect values. | ||
| - `zowe config secure` to have Zowe CLI prompt for your secure configuration properties in case your secure values are incorrect in your configuration. |
There was a problem hiding this comment.
Should we mention the need for the --global-config and --user-config depending on what the user is trying to update? 😋
|
|
||
| - `zowe config edit` to open your `~/.zowe/zowe.config.json` configuration file in your system's default text editor. Fix any properties with incorrect values. | ||
| - `zowe config secure` to have Zowe CLI prompt for your secure configuration properties in case your secure values are incorrect in your configuration. | ||
| - `zowe config report-env` to generate a report on the status of the key areas in your working environment. Address any problems indicated in the report. |
There was a problem hiding this comment.
I suggest moving the report-env command to the top of this bulleted list. It is (in my opinion) the one that will provide the most information that user can leverage to troubleshoot the CLI. 😋
|
|
||
| For example usage syntax, see the readme for each API package in this repository: | ||
| For example usage syntax, see the ReadMe for each API package in this repository: |
|
|
||
| Connection details can be managed efficiently within one file, promoting a global configuration that can be shared across teams and mainframe services. For more information on how to use profiles, visit [Zowe Docs](https://docs.zowe.org/stable/user-guide/cli-using-using-team-profiles/). | ||
| - Connection details can be managed efficiently within one file, promoting a global configuration that can be shared across teams and mainframe services. For more information on how to use profiles, see [Team configurations](https://docs.zowe.org/stable/user-guide/cli-using-using-team-profiles/) in Zowe Docs. |
There was a problem hiding this comment.
This bullet point is applicable for V3 as well, so...
Should we remove it form here? (given that it's is not a differentiator)
|
|
||
| Secure credential encryption is included in the core CLI. | ||
| - Secure credential encryption is included in the core CLI. |
There was a problem hiding this comment.
Same as the bullet point above 😋
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What It Does
Addresses Issue 1820
How to Test
Review Checklist
I certify that I have:
Additional Comments