Skip to content
This repository was archived by the owner on Nov 5, 2024. It is now read-only.

Commit bf6c599

Browse files
committed
Switches titles to -ing verbs, adds xrefs, corrects xrefs, and adds screenshots.
1 parent 6b8e015 commit bf6c599

File tree

8 files changed

+33
-35
lines changed

8 files changed

+33
-35
lines changed

docs/modules/ROOT/images/.DS_Store

0 Bytes
Binary file not shown.
114 KB
Loading
88.5 KB
Loading

docs/modules/ROOT/images/Logs.png

5.25 KB
Loading
36.5 KB
Loading
67.2 KB
Loading
Lines changed: 32 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
1-
= Get started
1+
= Getting started
22

33
{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.
44

5-
== Sign up
5+
== Signing up
66
Let’s get you signed up!
77

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

11-
== Create your first application
11+
== Creating your first application
1212
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.
1313

14-
=== Name your application
14+
=== Naming your application
1515
Every great app needs a name – add yours!
1616

1717
. Select *Create an application*.
1818
. Name your application.
1919

20-
=== Choose a bundled sample
20+
=== Choosing a bundled sample
2121

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

3030
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_.
3131

32-
=== Fork a sample repository
32+
=== Forking a sample repository
3333

3434
==== Why should you fork a sample?
3535

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

44-
==== Steps to fork
44+
==== How to fork a sample
4545

4646
To fork the sample, complete the following steps:
4747

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

57-
=== Import the code from your forked repository
57+
=== Importing the code from your forked repository
5858

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

64-
=== Review and configure
64+
=== Reviewing and configuring
6565
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.
6666

6767
For now, select *Default*.
6868

69-
=== Congrats!
69+
== Congrats!
7070

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

73-
=== Add more components
73+
== Next steps
74+
75+
=== Adding more components
7476

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

7779
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_.
7880

79-
In the *Overview* tab, select *Add component*.
81+
In the *Overview* tab, select *Add component*:
8082

81-
////
82-
image::modules/ROOT/images/Add_more_components.png[Overview tab that shows how you can add additional components to your application.]
83-
////
83+
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.]
8484

85-
=== Customize your build pipeline
85+
=== Customizing your build pipeline
8686

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

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

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

95-
=== View your activity
95+
=== Viewing your activity
9696
You can view your latest commits, as well as your pipeline runs.
9797

98-
==== View your latest commits
98+
==== Viewing your latest commits
9999

100100
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.
101101

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

104-
==== View your pipeline runs
104+
==== Viewing your pipeline runs
105105

106106
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.
107107

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

110-
=== Add an integration test
110+
=== Adding an integration test
111111

112112
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.
113113

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

121-
=== View your application route
121+
=== Viewing your application route
122122

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

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

129-
=== Examine your integration test results
129+
=== Examining your integration test results
130130

131131
You can view your test results in two different ways:
132132

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

136-
////
137-
image::logs[In Activity after you select Pipeline runs, there is a tab called Logs.]
138-
////
136+
image::Logs_step2.png[In Activity after you select Pipeline runs, there is a tab called Logs.]
139137

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

143-
////
144-
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.]
145-
////
141+
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.]
146142

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

149-
== What's next
145+
== Great work!
146+
Congrats on creating your first application!
150147

151148
////
152-
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.
149+
== What's next
150+
Add in importing code link when ready
153151
////

docs/modules/ROOT/pages/getting-started/why-product-name.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,4 +54,4 @@ After you merge the PR, the commit activity shows that the merged commit is bein
5454
With {ProductName}, it’s easy to automate the application creation process from commit to production deployment.
5555

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

0 commit comments

Comments
 (0)