Merge pull request #765 from CaroMac/removeeclipse

Remove eclipse plugin refs from documentation
galasa-dev · Mar 14, 2024 · 754b952 · 754b952
2 parents e8a5f90 + e629e13
commit 754b952
Show file tree

Hide file tree

Showing 43 changed files with 671 additions and 904 deletions.
diff --git a/src/data/nav.yaml b/src/data/nav.yaml
@@ -30,48 +30,37 @@
       items:
         - title: Galasa Architecture
           path: /docs/architecture
-        - title: Installing options
-          path: /docs/
         - title: Getting started using the Galasa CLI
-          path: /docs/cli-command-reference/cli-command-reference
+          path: /docs
           items: 
-            - title: CLI prerequisites
+            - title: CLI prerequisites online
               path: /docs/cli-command-reference/cli-prereqs
-            - title: Installing the Galasa CLI
+            - title: CLI prerequisites offline
+              path: /docs/cli-command-reference/zipped-prerequisites 
+            - title: Installing the Galasa CLI online
               path: /docs/cli-command-reference/installing-cli-tool
+            - title: Installing the Galasa CLI offline
+              path: /docs/cli-command-reference/installing-offline
             - title: Galasa CLI commands
               path: /docs/cli-command-reference/cli-command-reference-about  
             - title: Initialising your local environment
-              path: /docs/initialising-home-folder 
-            - title: Creating a project using the CLI
+              path: /docs/cli-command-reference/initialising-home-folder 
+            - title: Creating a Galasa project 
               path: /docs/writing-own-tests/setting-up-galasa-project
             - title: Running a test locally
               path: /docs/cli-command-reference/cli-runs-submit-local
             - title: Debugging a test locally
               path: /docs/cli-command-reference/cli-runs-local-debug
             - title: Viewing test results locally
               path: /docs/cli-command-reference/viewing-test-results-cli
-            - title: Exploring Galasa SimBank using the CLI
+            - title: Exploring Galasa SimBank online
               path: /docs/cli-command-reference/simbank-cli
-            - title: Running the SimBank tests using the CLI
-              path: /docs/running-simbank-tests-cli
-        - title: Getting started using Eclipse
-          path: /docs/getting-started/
-          items:
-            - title: Eclipse prerequisites
-              path: /docs/getting-started/eclipse-prereqs
-            - title: Installing the Galasa plug-in 
-              path: /docs/getting-started/installing-online
-            - title: Installing the Galasa plug-in offline
-              path: /docs/getting-started/installing-offline
-            - title: Exploring Galasa SimBank using Eclipse
-              path: /docs/getting-started/simbank
-            - title: Creating a project using Eclipse
-              path: /docs/running-simbank-tests/setting-up-galasa-project-eclipse
-            - title: Running the SimBank tests using Eclipse
-              path: /docs/running-simbank-tests-eclipse
-            - title: Viewing test results locally
-              path: /docs/running-simbank-tests/viewing-test-results
+            - title: Exploring Galasa SimBank offline
+              path: /docs/cli-command-reference/simbank-cli-offline
+            - title: Running the SimBank tests online
+              path: /docs/cli-command-reference/running-simbank-tests-cli
+            - title: Running the SimBank tests offline
+              path: /docs/cli-command-reference/running-simbank-tests-cli-offline   
         - title: Exploring the supplied SimBank tests
           path: /docs/exploring-simbank-tests
           items:

diff --git a/src/markdown-pages/doc_root.md b/src/markdown-pages/doc_root.md
diff --git a/src/markdown-pages/doc_root_old.md b/src/markdown-pages/doc_root_old.md
@@ -0,0 +1,19 @@
+---
+path: "/docs/old"
+title: "Installing options"
+---
+
+There are two options available when downloading Galasa. Prerequisites vary, depending on the option that is chosen. 
+
+You can download Galasa from the [Galasa cli repository](https://github.com/galasa-dev/cli/releases) in GitHub, or you can download the Galasa zipped distribution for sharing with your department. If you do not have access to Maven Central or Docker Hub from your company network, use the Galasa zipped distribution. Otherwise, download the binary file for the Galasa CLI from GitHub.  
+
+You downloaded and installed Galasa, you can import the configuration into an IDE of your choice.
+
+
+## Next steps
+
+If you are installing Galasa from GitHub, follow the instructions in the [Getting started using the CLI](/docs/cli-command-reference/cli-command-reference) documentation.
+
+If you are installing the zipped distribution of Galasa, follow the instructions in the [Getting started using the zipped distribution](/docs/first-steps/getting-started-zipped) documentation. 
+
+To find out about the architecture of Galasa and some of its key components, take a look at the [Galasa architecture](/docs/architecture) documentation. 
diff --git a/src/markdown-pages/docs/architecture.md b/src/markdown-pages/docs/architecture.md
@@ -3,7 +3,7 @@ path: "/docs/architecture"
 title: "Architecture"
 ---
 
-To get going with Galasa as quickly as possible, explore the [Installing options](/docs) section. Read on to learn a little about Galasa's architecture and key components.
+To get going with Galasa as quickly as possible, explore the [Getting started using the Galasa CLI](/docs) section. Read on to learn a little about Galasa's architecture and key components.
 
 # Galasa's architecture
 At its top level, Galasa decomposes into three major components:

diff --git a/src/markdown-pages/docs/cli-command-reference/cli-command-reference.md b/src/markdown-pages/docs/cli-command-reference/cli-command-reference.md
diff --git a/src/markdown-pages/docs/cli-command-reference/cli-prereqs.md b/src/markdown-pages/docs/cli-command-reference/cli-prereqs.md
@@ -1,22 +1,21 @@
 ---
 path: "/docs/cli-command-reference/cli-prereqs"
-title: "CLI prerequisites"
+title: "CLI prerequisites online"
 ---
 
 
-The following section explains more about the software prerequisites that you need to install so that you are ready to install Galasa for using in the command-line.
-
+The following section explains more about the software prerequisites that you need so that you are ready to install Galasa from the Galasa CLI repository in GitHub.
 
 ## Prerequisites
 
 | Software |  Description  |
 | :---- | :-------- | 
 | Java JDK  | Required. Galasa tests and Managers are written in Java - you need to install a Java version 11 JDK or later to use it. _Note:_ We do not currently support Java 17 or later. After installing, you must set the `JAVA_HOME` environment variable to your Java JDK installation path and check it set successfully by running the command `echo $JAVA_HOME` on Mac or Unix, or `echo %JAVA_HOME%` on Windows (PowerShell). The returned result shows the path to your JDK installation.|
 | Maven or Gradle  | You must install either Maven or Gradle in order to build Galasa projects. Galasa projects are hierarchical file structures that provide the ability to store and run Galasa tests. All Galasa versions are compatible with Gradle releases 6.9.x. Remember to add Gradle to your Path. You can check by running `echo $PATH` on Mac or Unix, or `echo %PATH%` on Windows (PowerShell). |
-| 3270 emulator | Optional. Although you do not need a 3270 emulator to run a Galasa test (even if it tests a 3270 application) you can use one to [explore Galasa Simbank](../cli-command-reference/simbank-cli), a simulated version of an application that helps you get acquainted with Galasa before connecting to a real mainframe to run your own tests. There are many such emulators available but IBM's Personal Communications (PCOMM) is frequently used, as is IBM's Host on Demand software, which includes support for Windows, Linux and MacOS.| 
+| 3270 emulator | Optional. Although you do not need a 3270 emulator to run a Galasa test (even if it tests a 3270 application) you can use one to [explore Galasa Simbank online](../cli-command-reference/simbank-cli), a simulated version of an application that helps you get acquainted with Galasa before connecting to a real mainframe to run your own tests. There are many such emulators available but IBM's Personal Communications (PCOMM) is frequently used, as is IBM's Host on Demand software, which includes support for Windows, Linux and MacOS.| 
 
 
 ## Next steps
 
-To install Galasa for using in the command line, follow the instructions in the [Installing the Galasa CLI](/docs/cli-command-reference/installing-cli-tool) documentation.
+To install Galasa for using in the command line, follow the instructions in the [Installing the Galasa CLI online](/docs/cli-command-reference/installing-cli-tool) documentation.
 
diff --git a/src/markdown-pages/docs/cli-command-reference/doc_root.md b/src/markdown-pages/docs/cli-command-reference/doc_root.md
@@ -0,0 +1,22 @@
+---
+path: "/docs"
+title: "Getting started using the Galasa CLI"
+---
+
+
+There are two options available when downloading Galasa. You can download Galasa from the <a href="https://github.com/galasa-dev/cli/releases" target="_blank"> Galasa CLI repository</a> in GitHub, or you can download the Galasa zipped distribution for sharing with your department. If you do not have access to Maven Central or Docker Hub from your company network, use the Galasa zipped distribution. Otherwise, download the binary file for the Galasa CLI from GitHub. Once you have downloaded and installed Galasa, you can import the configuration into an IDE of your choice.
+
+Prerequisites vary, depending on the option that is chosen. For the purposes of the Galasa documentation, the term `online` refers to the Galasa binary that is downloaded from the Galasa CLI repository in GitHub, and the term `offline` refers to Galasa zipped distribution. 
+
+The following topics in this section take you through the software requirements for each install option, and explain how to get started with the galasactl tool. You can then find out how to initialise your local environment so that you can start creating, building and running Galasa tests, and viewing the test run output. 
+
+
+## Next steps
+
+To learn about the software that you need to install to start using Galasa, see the [CLI prerequisites online](/docs/cli-command-reference/cli-prereqs) documentation, or the [CLI prerequisites offline](/docs/cli-command-reference/zipped-prerequisites) documentation, depending on which option you have chosen.
+
+To find out about the architecture of Galasa and some of its key components, take a look at the [Galasa architecture](/docs/architecture) documentation. 
+
+If you have access to YouTube, you can also watch a video about the <a href="https://www.youtube.com/watch?v=lwYOwJZ4Q8Q" target="_blank">The Galasa command line tool</a>, which guides you through the process of setting up and using the tool from start to finish. 
+
+