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

Commit 69172ff

Browse files
Merge branch 'main' into slsa-doc
2 parents 957b125 + 5bb5ab2 commit 69172ff

File tree

5 files changed

+49
-43
lines changed

5 files changed

+49
-43
lines changed

docs/modules/ROOT/images/.DS_Store

0 Bytes
Binary file not shown.
207 KB
Loading
153 KB
Loading

docs/modules/ROOT/nav-concepts.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
* Concepts
22
** xref:concepts/slsa/con_slsa-conformity.adoc[Supply chain security through SLSA conformity]
3-
** xref:concepts/RenovateBot/index.adoc[RenovateBot]
43
** xref:concepts/java-build-service/java-build-service.adoc[Java build service]
54
** xref:concepts/java-build-service/java-build-service-components.adoc[Java build service components]
65
76
////
87
Adam Kaplan said that the index.adoc for Pipelines, and presumably the other docs in that directory, need to be rewritten, since index.adoc was based on an old version of {ProductName} that used KCP. --Christian csears@redhat.com 3/1/23
8+
** xref:concepts/RenovateBot/index.adoc[RenovateBot]
99
** xref:concepts/pipelines/index.adoc[Pipelines]
1010
*** xref:concepts/pipelines/persister.adoc[Persister component]
1111
*** xref:concepts/pipelines/pipeline_concepts.adoc[Pipeline concepts]

docs/modules/ROOT/pages/getting-started/get-started.adoc

Lines changed: 48 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
= Getting started
1+
= Getting started with {ProductName}
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

@@ -11,16 +11,12 @@ Let’s get you signed up!
1111
== 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-
=== Naming your application
15-
Every great app needs a name – add yours!
16-
17-
. Select *Create an application*.
18-
. Name your application.
14+
To begin the process, click *Create an application*.
1915

2016
=== Choosing a bundled sample
2117

22-
. Click *Start with a sample*.
23-
. Choose one of the following options:
18+
Scroll to the section *Select a sample* and choose one of the following options:
19+
2420
* Node.js
2521
* Quarkus
2622
* Spring Boot
@@ -33,19 +29,20 @@ Decided on a favorite sample? Great! Now let’s fork the code to your repo in t
3329

3430
==== Why should you fork a sample?
3531

36-
There are many perks to forking one of our samples, this list shows a few:
32+
There are many perks to forking one of our samples, for example:
3733

3834
* Pipeline customization
3935
* Automated builds for new commits with GitHub webhook integration
4036
* Pull request testing
4137
* Rebuilding dependencies from source
4238
* Scanning your build for vulnerabilities, viruses, and other checks
4339

40+
[#How to fork a sample]
4441
==== How to fork a sample
4542

4643
To fork the sample, complete the following steps:
4744

48-
. In the sample that you chose, click *Git repository*. This link takes you to GitHub.
45+
. Click *Open Git repository* for the sample that you chose. This link takes you to GitHub.
4946
. Now that you’re in GitHub, click *Fork*.
5047
. Copy the URL of this new forked repository. We'll use this URL in the next section!
5148

@@ -54,50 +51,60 @@ To fork the sample, complete the following steps:
5451
Right now we support GitHub, but come back soon for other Git providers!
5552
====
5653

54+
5755
=== Importing the code from your forked repository
5856

59-
. Return to the app and go back to the *Select a sample* view.
60-
. Click *Import your code*.
61-
. In *Git repo URL*, paste the URL that you copied in the previous section.
62-
. Click *Next*.
57+
. Return to the app and scroll up to *Bring in your own code*.
58+
. In *Git repository URL*, paste the URL that you copied in the previous section.
59+
. Click *Import code*.
6360

61+
[#Reviewing and configuring]
6462
=== Reviewing and configuring
65-
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.
63+
We now 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. Let's stick with the default option for now.
64+
65+
Complete the following steps to finish the process:
6666

67-
For now, select *Default*.
67+
. In *Application details*, enter a name for your app.
68+
. In *Component name*, enter a name for your component.
69+
. Leave the toggle set to *Default build pipeline*.
70+
. Scroll to the end of the page and click *Create application*.
6871

6972
== Congrats!
7073

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

73-
== Next steps
76+
Great work! You're done with the first steps.
77+
78+
== Advanced options
7479

7580
=== Adding more components
7681

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

79-
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_.
84+
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_.
8085

8186
In the *Overview* tab, select *Add component*:
8287

8388
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.]
8489

90+
Follow the process in <<How to fork a sample>> to add any additional components.
91+
8592
=== Customizing your build pipeline
8693

87-
To add automation, you can upgrade your default build pipelines to custom build pipelines.
94+
In the <<Reviewing and configuring>> section, you used the default built pipeline. To add automation, you can upgrade to custom build pipelines.
8895

8996
Custom build pipelines are pipelines as code, set on your component's repository. With custom build pipelines, pull requests and commits to your main branch automatically rebuild.
9097

9198
By customizing your build pipeline, you can change the tasks that are included, control when those tasks update to newer versions, and accept any changes to the pipeline when you're ready for them.
9299

93-
To get started, click *Manage build pipelines* from the *Overview* page.
100+
To get started, click *Manage build pipelines* from the *Overview* page. For more information on this topic, go to xref:how-to-guides/proc_upgrade_build_pipeline.adoc[Upgrading your build pipeline].
94101

95102
=== Viewing your activity
96103
You can view your latest commits, as well as your pipeline runs.
97104

98105
==== Viewing your latest commits
99106

100-
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.
107+
Because 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.
101108

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

@@ -107,40 +114,39 @@ Didn’t fork your repo? Fret not! You can also view your activity by pipeline r
107114

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

110-
=== Adding an integration test
111-
112-
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.
117+
The following image shows the *Pipeline run details*:
113118

114-
To add an integration test, complete the following steps:
119+
image::Pipeline-runs.png[View of an application's pipeline runs. Multiple tasks are depicted in a tree flow and the user can click on a task to view more details.]
115120

116-
. Go to the *Integration tests* tab.
117-
. Click *Add integration test*.
118-
. Enter a name for your test, a path to the container image, and the name of the pipeline that you want to run.
119-
. Click *Add integration test*.
121+
In the previous view, you can see tasks that you can run based on the pipeline definition while the image is being inspected. You can also click an individual task to see its details.
120122

121-
=== Viewing your application route
123+
=== Viewing your application route
122124

123-
You can find each component’s route in the *Components* tab, next to each component’s details:
125+
You can find each component’s route in the *Components* tab, next to each component’s details.
124126

125-
////
126-
image::modules/ROOT/images/View-application-route.png[The Components tab has a hyperlink called Route that opens the current component's route.]
127-
////
127+
Refer to the following image:
128128

129-
=== Examining your integration test results
129+
image::Application_route.png[In the Components tab, there is a link called Route next to every component that takes you to the application route.]
130130

131-
You can view your test results in two different ways:
131+
=== Managing compliance with Enterprise Contract
132+
The Enterprise Contract (EC) is an artifact verifier and customizable policy checker. You can use EC to keep your software supply chain secure and to ensure that container images comply with your organization’s policies.
132133

133-
* Go to the *Activity* tab and select *Pipeline runs*.
134-
* View your integration test log output by selecting *Logs*:
135-
136-
image::Logs_step2.png[In Activity after you select Pipeline runs, there is a tab called Logs.]
134+
For more information about EC, refer to xref:how-to-guides/proc_managing-compliance-with-the-enterprise-contract.adoc[Managing compliance with the Enterprise Contract].
137135

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

141139
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.]
142140

143-
An environment is a set of compute resources that you can use to develop, test, and stage your applications.
141+
An environment is a set of compute resources that you can use to develop, test, and stage your applications. There is a development environment included for you so that you can explore {ProductName}.
142+
143+
For information about creating an application with your own cluster, refer to xref:how-to-guides/proc_creating_your_own_environment.adoc[Creating your own environment].
144+
145+
=== Examining your SBOM
146+
147+
A software bill of materials (SBOM) is a list of all the software libraries that a component uses. You can run 'cosign' in your command line interface (CLI) to inspect the image SBOM.
148+
149+
For more information on this topic, go to xref:how-to-guides/Secure-your-supply-chain/proc_inspect_sbom.adoc[Inspecting SBOMs].
144150

145151
== Great work!
146152
Congrats on creating your first application!

0 commit comments

Comments
 (0)