Skip to content
This repository was archived by the owner on Nov 5, 2024. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file modified docs/modules/ROOT/images/.DS_Store
Binary file not shown.
Binary file modified docs/modules/ROOT/images/Add_more_components.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/modules/ROOT/images/Environments.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/modules/ROOT/images/Logs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/modules/ROOT/images/Logs_step2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
66 changes: 32 additions & 34 deletions docs/modules/ROOT/pages/getting-started/index.adoc
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
= Get started
= Getting started

{ProductName} is a multi-tenant, software as a service (SaaS) based continuous integration and continuous delivery (CI/CD) service with an emphasis on secure supply chain features.

== Sign up
== Signing up
Let’s get you signed up!

. Go to https://console.redhat.com/beta/hac/application-pipeline[{ProductName}].
. Click *Join waitlist*.

== Create your first application
== Creating your first application
We include ready-to-use bundled code samples that you can import into our service. In this guide, we’ll walk you through how to fork a sample repository and create your first application.

=== Name your application
=== Naming your application
Every great app needs a name – add yours!

. Select *Create an application*.
. Name your application.

=== Choose a bundled sample
=== Choosing a bundled sample

. Click *Start with a sample*.
. Choose one of the following options:
Expand All @@ -29,7 +29,7 @@ Every great app needs a name – add yours!

Decided on a favorite sample? Great! Now let’s fork the code to your repo in the next section. By the way, we call this code a _component_.

=== Fork a sample repository
=== Forking a sample repository

==== Why should you fork a sample?

Expand All @@ -41,7 +41,7 @@ There are many perks to forking one of our samples, this list shows a few:
* Rebuilding dependencies from source
* Scanning your build for vulnerabilities, viruses, and other checks

==== Steps to fork
==== How to fork a sample

To fork the sample, complete the following steps:

Expand All @@ -54,35 +54,35 @@ To fork the sample, complete the following steps:
Right now we support GitHub, but come back soon for other Git providers!
====

=== Import the code from your forked repository
=== Importing the code from your forked repository

. Return to the app and go back to the *Select a sample* view.
. Click *Import your code*.
. In *Git repo URL*, paste the URL that you copied in the previous section.
. Click *Next*.

=== Review and configure
=== Reviewing and configuring
We scan your Git repository for source code and detect your runtime and other configuration settings for you to review. You have the option to use our default build pipeline or to customize the pipeline.

For now, select *Default*.

=== Congrats!
== Congrats!

Now click *Create* and we’ll start building your application. We build an image from the source code of this sample.
Now click *Create* and we’ll start building your application. We build an image from the source code of this sample.

=== Add more components
== Next steps

=== Adding more components

Because your application can run on one or more components, you might want to add more.

The additional source code that you add can either be from the same repository that you used when you created your application, _or_ a different Git repository. Remember, we call source code _components_.

In the *Overview* tab, select *Add component*.
In the *Overview* tab, select *Add component*:

////
image::modules/ROOT/images/Add_more_components.png[Overview tab that shows how you can add additional components to your application.]
////
image::Add_more_components.png[Overview tab that shows how you can add additional components to your application. The Overview button is on the bottom left and has a red arrow next to it.]

=== Customize your build pipeline
=== Customizing your build pipeline

To add automation, you can upgrade your default build pipelines to custom build pipelines.

Expand All @@ -92,22 +92,22 @@ By customizing your build pipeline, you can change the tasks that are included,

To get started, click *Manage build pipelines* from the *Overview* page.

=== View your activity
=== Viewing your activity
You can view your latest commits, as well as your pipeline runs.

==== View your latest commits
==== Viewing your latest commits

Since you forked your repo, you have permissions to commit to the Git repo. We like to focus on commits, rather than pipelines, so that it’s easy to correlate a developer's work with what’s going on in the system.

To view your recent commits, go to the *Activity* tab and click *Latest commits*.

==== View your pipeline runs
==== Viewing your pipeline runs

Didn’t fork your repo? Fret not! You can also view your activity by pipeline runs. A pipeline run is a collection of TaskRuns that are arranged in a specific order of execution.

To view your pipeline runs, go to the *Activity* tab and click *Pipeline runs*.

=== Add an integration test
=== Adding an integration test

An integration test is a pipeline that you set up in GitHub. When you add components, it tests each one individually, and then tests the application as a whole.

Expand All @@ -118,36 +118,34 @@ To add an integration test, complete the following steps:
. Enter a name for your test, a path to the container image, and the name of the pipeline that you want to run.
. Click *Add integration test*.

=== View your application route
=== Viewing your application route

You can find each component’s route in the *Components* tab, next to each component’s details:

////
image::modules/ROOT/images/View-application-route.png[The Components tab has a hyperlink called Route that opens the current component's route.]
////

=== Examine your integration test results
=== Examining your integration test results

You can view your test results in two different ways:

* Go to the *Activity* tab and select *Pipeline runs*.
* View your integration test log output by selecting Logs:
* View your integration test log output by selecting *Logs*:

////
image::logs[In Activity after you select Pipeline runs, there is a tab called Logs.]
////
image::Logs_step2.png[In Activity after you select Pipeline runs, there is a tab called Logs.]

=== Deploy your app
Check the status of your application in *Environments*. You can view your type of environment, its strategy, and its deployment status:
=== Deploying your app
Check the status of your application in *Environments*. You can view information about your environment such as its type, strategy, and deployment status:

////
image::modules/ROOT/images/Environments-tab.png[The Environments tab shows the status of your environment, its deployment strategy, the health of your application, and your last deploy date. In this example, the development is Static, the strategy is Automatic, the application is healthy, and the last deploy was on March 7, 2023 at 11:58 AM.]
////
image::Environments.png[The Environments tab shows the type of your environment, its deployment strategy, the cluster type, the application status, the last deploy, and the applications deployed. In this example, the type is Default, the strategy is Automatic, the cluster type is OpenShift, the Application status is Missing, the Last deploy is -, and there are 3 applications deployed.]

An environment is a set of compute resources that you can use to develop, test, and stage your applications.

== What's next
== Great work!
Congrats on creating your first application!

////
Congrats on creating your first application! To learn more about {ProductName}, check out our xref:index.adoc[How-to-guides] or our xref:concepts/index.adoc[Concepts] section.
== What's next
Add in importing code link when ready
////
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,4 @@ After you merge the PR, the commit activity shows that the merged commit is bein
With {ProductName}, it’s easy to automate the application creation process from commit to production deployment.

== What’s next
To learn how to create an app with a sample, go to xref:getting-started/index.adoc[Get started].
To learn how to create an app with a sample, go to xref:getting-started/index.adoc[Getting started].