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

Publish release 32 docs from next to main #770

Merged
merged 35 commits into from
Mar 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
41bf22f
runs reset and cancel cmds
CaroMac Feb 7, 2024
f7cbbb4
update delete to cancel
CaroMac Feb 7, 2024
90f2aae
add log info
CaroMac Feb 7, 2024
7b6793a
Merge branch 'next' into issue1479
CaroMac Feb 21, 2024
09e0024
add authentication
CaroMac Feb 26, 2024
880670f
remove eclipse
CaroMac Feb 27, 2024
1a0ccbb
add blog and update auth
CaroMac Feb 27, 2024
70becb5
update blog and auth
CaroMac Feb 27, 2024
423ab0b
updates to eclipse removal
CaroMac Feb 28, 2024
a12fbd3
add gherkin info
CaroMac Feb 28, 2024
0132f68
review updates
CaroMac Feb 29, 2024
792c878
minor update
CaroMac Mar 4, 2024
e9be93d
Merge pull request #766 from CaroMac/gherkin
CaroMac Mar 4, 2024
67a2db1
Merge branch 'next' into issue1479
CaroMac Mar 4, 2024
aef86a2
fix links and edit nav
CaroMac Mar 5, 2024
5af3971
update link
CaroMac Mar 5, 2024
6448ea4
minor update
CaroMac Mar 5, 2024
df4e723
updates to offline install
CaroMac Mar 7, 2024
9a87e70
add 32 release notes and update 31 to 32 where needed
CaroMac Mar 7, 2024
b5e7841
r32 release notes
CaroMac Mar 11, 2024
9f4541f
Merge branch 'next' into authtoken
CaroMac Mar 12, 2024
7b1c58a
add installing offline doc
CaroMac Mar 13, 2024
7367238
Merge pull request #763 from CaroMac/authtoken
CaroMac Mar 13, 2024
0ac3f6b
Merge branch 'next' into issue1479
CaroMac Mar 13, 2024
b5ffebd
Merge pull request #754 from CaroMac/issue1479
CaroMac Mar 13, 2024
98a88b9
Merge branch 'next' into release32notes
CaroMac Mar 13, 2024
943a4c4
fix links
CaroMac Mar 13, 2024
e8a5f90
Merge pull request #769 from CaroMac/release32notes
CaroMac Mar 13, 2024
2f19892
add reminder
CaroMac Mar 13, 2024
005d7a5
review comment updates
CaroMac Mar 14, 2024
5385442
remove cmd
CaroMac Mar 14, 2024
e629e13
Merge branch 'next' into removeeclipse
CaroMac Mar 14, 2024
754b952
Merge pull request #765 from CaroMac/removeeclipse
CaroMac Mar 14, 2024
f5c8e48
removed file causing conflict
KirbyKatcher Mar 14, 2024
7df4a5d
Merge pull request #773 from galasa-dev/merge-conflict-resolution
KirbyKatcher Mar 14, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 21 additions & 28 deletions src/data/nav.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -104,7 +93,9 @@
- title: Ecosystem architecture
path: /docs/ecosystem/architecture
- title: Installing an Ecosystem using Helm
path: /docs/ecosystem/installing/k8s
path: /docs/ecosystem/ecosystem-installing-k8s
- title: Configuring authentication
path: /docs/ecosystem/ecosystem-authentication
- title: Test streams
path: /docs/writing-own-tests/test-streams
- title: Managing integrated test runs
Expand All @@ -115,6 +106,8 @@
path: /docs/cli-command-reference/ecosystem-cli-runs-prepare
- title: Running tests in an Ecosystem
path: /docs/cli-command-reference/ecosystem-cli-runs-submit
- title: Retrying and cancelling tests
path: /docs/cli-command-reference/runs-reset-cancel
- title: Viewing test run results
path: /docs/cli-command-reference/cli-runs-get
- title: Downloading test artifacts
Expand Down
23 changes: 0 additions & 23 deletions src/markdown-pages/doc_root.md

This file was deleted.

19 changes: 19 additions & 0 deletions src/markdown-pages/doc_root_old.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion src/markdown-pages/docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

This file was deleted.

9 changes: 4 additions & 5 deletions src/markdown-pages/docs/cli-command-reference/cli-prereqs.md
Original file line number Diff line number Diff line change
@@ -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.

22 changes: 22 additions & 0 deletions src/markdown-pages/docs/cli-command-reference/doc_root.md
Original file line number Diff line number Diff line change
@@ -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.


Loading
Loading