Docs change for Zowe Explorer plug-in for IntelliJ IDEA #3855

KUGDev · 2024-09-05T17:26:02Z

Describe your pull request here:
Changes for Zowe Explorer plug-in for IntelliJ IDEA and Zowe Client Kotlin SDK

List the file(s) included in this PR:
See the files, included in the PR

After creating the PR, follow the instructions in the comments.

zFernand0 · 2024-09-09T20:46:16Z

The build should be fixed on the v3-doc-branch now. Feel free to update your branch 🥳

KUGDev · 2024-09-09T21:33:22Z

The build should be fixed on the v3-doc-branch now. Feel free to update your branch 🥳

Did rebase
@anaxceron

github-actions · 2024-09-09T21:54:26Z

🚀 Deployed on https://66e1bdd12adcdc299da0d20e--zowe-docs-master.netlify.app

anaxceron

Left some comments re: style, grammar, etc.

anaxceron · 2024-09-09T14:51:24Z

docs/getting-started/install-zowe-sdks.md

-```
-import org.zowe.kotlinsdk
-```
+For the detailed information about how to install the library, refer to [the official installation guide for Zowe Client Kotlin SDK](https://zowe.github.io/zowe-client-kotlin-sdk/#installation)


Please remove "the" after "For", and end this sentence w/ a period.

anaxceron · 2024-09-09T14:52:37Z

docs/getting-started/overview.md


-For more information, see [Using Zowe IntelliJ plug-in](../user-guide/intellij-using.md).
+To see more about it, you can start with [Zowe Explorer plug-in for IntelliJ IDEA use cases](../user-guide/intellij-use-cases.md).


What do we mean by "To see more about it"? Are we inviting people to use the plug-in?

anaxceron · 2024-09-09T14:57:16Z

docs/getting-started/zowe_faq.md


 <details className="zowe-faq">

 <summary></summary>

-You can read detailed user guide and find any information you need [here](https://plugins.jetbrains.com/plugin/18688-zowe-explorer/user-guide). Also, you can ask any questions in the Zowe Slack channel [#zowe-explorer-intellij](https://openmainframeproject.slack.com/archives/C020BGPSU0M).
+You can start with the [use cases](../user-guide/intellij-use-cases.md) section of the usage guide and continue with all the other related sections that describe in details how to get started. Also, you can ask any questions in our [Zowe Slack channel (#zowe-explorer-intellij)](https://openmainframeproject.slack.com/archives/C020BGPSU0M).


"details" should be singular.

Also, this sentence is a bit awkward. Please edit to something like: Read the user guide(link) to learn about use cases and to learn how to install and use the plug-in.

There is no "user guide" as a singular section

anaxceron · 2024-09-09T14:58:36Z

docs/getting-started/zowe_faq.md

-<summary></summary>
-
-If you have something to introduce but there is no related issue in the project repo, then you can either create the issue by yourself or contact us to help you with it. See more information in the [CONTRIBUTION.md](https://github.com/zowe/zowe-explorer-intellij/blob/main/CONTRIBUTING.md) file.  
+In case you have any idea on how to improve our plug-in, or have an issue / a bugfix in mind, visit our [contribution guide](https://github.com/zowe/zowe-explorer-intellij/blob/main/CONTRIBUTING.md). Also, you can ask for help in our [Zowe Slack channel (#zowe-explorer-intellij)](https://openmainframeproject.slack.com/archives/C020BGPSU0M).


Please change to: If you have ideas on how to improve the plug-in, or have an issue/bug fix in mind, visit the contribution guide(link).

anaxceron · 2024-09-09T15:00:43Z

docs/troubleshoot/troubleshoot-check-your-zowe-version.md

-3. Search for, and select, `Zowe Explorer`.
-
-    The Zowe Explorer marketplace details display on the right side of the window. The version number is located adjacent to the Zowe Explorer name.
+All the details are described in our "step-by-step" guide [here](./troubleshoot-intellij)


Please change: See the guide(link) for instructions.

anaxceron

Made additional comments re: style, typos, etc. Please fix before merging the PR.

anaxceron · 2024-09-11T15:08:52Z

docs/getting-started/overview.md

- Highlight all IntelliJ supported languages automatically and recognize them once opened from the mainframe.
+The plug-in helps to: 
+- Start working with z/OS easily with no complex configurations
+- Organize datasets on z/OS, files on USS into working sets


"Data sets" is two words in Zowe Docs -- please change throughout the files in this PR

anaxceron · 2024-09-11T15:09:45Z

docs/getting-started/overview.md

+- Organize datasets on z/OS, files on USS into working sets
+- Allocate datasets, create members, files and directories with different permissions
+- Perform operations like renaming, copying and moving data in a modern way
+- Edit datasets, files and members. Smart auto-save keeps your content both in the editor and on the mainframe in-sync


no hyphen in "in sync"

anaxceron · 2024-09-11T15:11:16Z

docs/getting-started/zowe_faq.md

@@ -34,7 +34,7 @@ Zowe technology can be used by a variety of mainframe IT and non-IT professional

 <summary></summary>

-Zowe consists of several components. The primary languages for API Mediation Layer are Java and JavaScript. Zowe CLI, Explorer for VSCode and Desktop are written in TypeScript. Explorer for IntelliJ is written in Kotlin, ZSS is written in C, while the cross memory server is written in metal C.
+Zowe consists of several components. The primary languages for API Mediation Layer are Java and JavaScript. Zowe CLI, Explorer for VSCode and Desktop are written in TypeScript. Zowe Explorer plug-in for IntelliJ IDEA is written in Kotlin, ZSS is written in C, while the cross memory server is written in metal C.


Zowe Docs uses the Oxford comma: "Zowe CLI, Explorer for VS Code, and Desktop ..."

anaxceron · 2024-09-11T15:13:04Z

docs/getting-started/zowe_faq.md


-### Why might I use Zowe IntelliJ plug-in versus a traditional ISPF interface to perform mainframe tasks?
+### Why might I use the plug-in versus a traditional ISPF interface to perform mainframe tasks?


I think we should change the question to "Why should I use ... " or "Why would I use ... "

anaxceron · 2024-09-11T15:16:15Z

docs/getting-started/zowe_faq.md


 <details className="zowe-faq">

 <summary></summary>

-You can read detailed user guide and find any information you need [here](https://plugins.jetbrains.com/plugin/18688-zowe-explorer/user-guide). Also, you can ask any questions in the Zowe Slack channel [#zowe-explorer-intellij](https://openmainframeproject.slack.com/archives/C020BGPSU0M).
+You can start with [use cases](../user-guide/intellij-use-cases.md) section to learn about use cases and to learn how to install and use the plug-in. Also, you can ask any questions in our [Zowe Slack channel (#zowe-explorer-intellij)](https://openmainframeproject.slack.com/archives/C020BGPSU0M).


missing a word; capitalize the section title; remove one unnecessary "to learn": "You can start with the Use case section to learn about use case and how to install and ... "

Signed-off-by: Uladzislau <leksilonchikk@gmail.com>

KUGDev requested review from janan07 and anaxceron September 5, 2024 17:26

anaxceron assigned KUGDev Sep 9, 2024

anaxceron added area: SDK Issues/content related to Zowe SDKs release: V3 Zowe V3 content review: doc Needs review by Doc Squad member labels Sep 9, 2024

KUGDev force-pushed the zowe-explorer-intellij-and-kotlin-sdk branch from 31c60e4 to 410a92a Compare September 9, 2024 21:32

anaxceron reviewed Sep 10, 2024

View reviewed changes

KUGDev force-pushed the zowe-explorer-intellij-and-kotlin-sdk branch from 410a92a to 7b2bcca Compare September 10, 2024 16:37

KUGDev requested a review from anaxceron September 10, 2024 16:38

KUGDev force-pushed the zowe-explorer-intellij-and-kotlin-sdk branch from 7b2bcca to 32d72bc Compare September 11, 2024 14:20

anaxceron approved these changes Sep 11, 2024

View reviewed changes

Docs change for Zowe Explorer plug-in for IntelliJ IDEA

8dff3d9

Signed-off-by: Uladzislau <leksilonchikk@gmail.com>

KUGDev force-pushed the zowe-explorer-intellij-and-kotlin-sdk branch from 32d72bc to 8dff3d9 Compare September 11, 2024 15:39

KUGDev removed the request for review from janan07 September 12, 2024 17:03

anaxceron merged commit bddfb2e into zowe:v3-doc-branch Sep 12, 2024
3 checks passed

KUGDev deleted the zowe-explorer-intellij-and-kotlin-sdk branch September 12, 2024 22:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs change for Zowe Explorer plug-in for IntelliJ IDEA #3855

Docs change for Zowe Explorer plug-in for IntelliJ IDEA #3855

KUGDev commented Sep 5, 2024

zFernand0 commented Sep 9, 2024

KUGDev commented Sep 9, 2024

github-actions bot commented Sep 9, 2024 •

edited

Loading

anaxceron left a comment

anaxceron Sep 9, 2024

anaxceron Sep 9, 2024

anaxceron Sep 9, 2024

KUGDev Sep 10, 2024

anaxceron Sep 9, 2024

anaxceron Sep 9, 2024

anaxceron left a comment

anaxceron Sep 11, 2024

anaxceron Sep 11, 2024

anaxceron Sep 11, 2024

anaxceron Sep 11, 2024

anaxceron Sep 11, 2024


		For more information, see [Using Zowe IntelliJ plug-in](../user-guide/intellij-using.md).
		To see more about it, you can start with [Zowe Explorer plug-in for IntelliJ IDEA use cases](../user-guide/intellij-use-cases.md).


		### Why might I use Zowe IntelliJ plug-in versus a traditional ISPF interface to perform mainframe tasks?
		### Why might I use the plug-in versus a traditional ISPF interface to perform mainframe tasks?

Docs change for Zowe Explorer plug-in for IntelliJ IDEA #3855

Docs change for Zowe Explorer plug-in for IntelliJ IDEA #3855

Conversation

KUGDev commented Sep 5, 2024

zFernand0 commented Sep 9, 2024

KUGDev commented Sep 9, 2024

github-actions bot commented Sep 9, 2024 • edited Loading

anaxceron left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anaxceron left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Sep 9, 2024 •

edited

Loading