// Module included in the following assemblies:
//
// * web_console/creating-quick-start-tutorials.adoc

:_mod-docs-content-type: CONCEPT
[id="understanding-quick-start-elements_{context}"]
= Mapping the elements in the quick start to the quick start CR

[role="_abstract"]
These mappings show where each part of the quick start custom resource (CR) is displayed in the quick start within the web console.

[id="conclusion-quick-start-element_{context}"]
== Conclusion element

.Viewing the conclusion element in the YAML file
[source,yaml]
----
...
summary:
  failed: Try the steps again.
  success: Your Spring application is running.
title: Run the Spring application
conclusion: >-
  Your Spring application is deployed and ready.
----

The `conclusion` field defines the conclusion text.

In the web console, the conclusion is displayed in the last section of the quick start.

image::quick-start-conclusion.png[quick start conclusion in the web console]

[id="description-quick-start-element_{context}"]
== Description element

.Viewing the description element in the YAML file
[source,yaml]
----
apiVersion: console.openshift.io/v1
kind: ConsoleQuickStart
metadata:
  name: spring-with-s2i
spec:
  description: 'Import a Spring Application from git, build, and deploy it onto OpenShift.'
...
----

The `description` field defines the description text.

In the web console, the description is displayed on the introductory tile of the quick start on the *Quick Starts* page.

image::quick-start-description.png[quick start description in the web console]


[id="displayName-quick-start-element_{context}"]
== The `displayName` element

.Viewing the `displayName` element in the YAML file

[source,yaml]
----
apiVersion: console.openshift.io/v1
kind: ConsoleQuickStart
metadata:
  name: spring-with-s2i
spec:
  description: 'Import a Spring Application from git, build, and deploy it onto OpenShift.'
  displayName: Get started with Spring
  durationMinutes: 10
----

The `displayName` field defines the display name text.

In the web console, the display name is displayed on the introductory tile of the quick start on the *Quick Starts* page.

image::quick-start-display-name.png[quick start display name in the web console]

[id="duration-minutes-quick-start-element_{context}"]
== The `durationMinutes` element

.Viewing the `durationMinutes` element in the YAML file

[source,yaml]
----
apiVersion: console.openshift.io/v1
kind: ConsoleQuickStart
metadata:
  name: spring-with-s2i
spec:
  description: 'Import a Spring Application from git, build, and deploy it onto OpenShift.'
  displayName: Get started with Spring
  durationMinutes: 10
----

The `durationMinutes` field defines, in minutes, how long the quick start should take to complete.

In the web console, the duration minutes element is displayed on the introductory tile of the quick start on the *Quick Starts* page.

image::quick-start-duration.png[quick start durationMinutes element in the web console]

[id="icon-quick-start-element_{context}"]
== Icon element

.Viewing the icon element in the YAML file

[source,yaml]
----
...
spec:
  description: 'Import a Spring Application from git, build, and deploy it onto OpenShift.'
  displayName: Get started with Spring
  durationMinutes: 10
  icon: >-
    data:image/svg+xml;base64, 
...
----

The `icon` field defines the icon as a base64 value.

In the web console, the icon is displayed on the introductory tile of the quick start on the *Quick Starts* page.

image::quick-start-icon.png[quick start icon element in the web console]

[id="introduction-quick-start-element_{context}"]
== Introduction element

.Viewing the introduction element in the YAML file

[source,yaml]
----
...
  introduction: >-
    **Spring** is a Java framework for building applications based on a distributed microservices architecture.

    - Spring enables easy packaging and configuration of Spring applications into a self-contained executable application which can be easily deployed as a container to OpenShift.

    - Spring applications can integrate OpenShift capabilities to provide a natural "Spring on OpenShift" developer experience for both existing and net-new Spring applications. For example:

    - Externalized configuration using Kubernetes ConfigMaps and integration with Spring Cloud Kubernetes

    - Service discovery using Kubernetes Services

    - Load balancing with Replication Controllers

    - Kubernetes health probes and integration with Spring Actuator

    - Metrics: Prometheus, Grafana, and integration with Spring Cloud Sleuth

    - Distributed tracing with Istio

    - Developer tooling through Red Hat OpenShift and Red Hat CodeReady developer tooling to quickly scaffold new Spring projects, gain access to familiar Spring APIs in your favorite IDE, and deploy to Red Hat OpenShift
...
----

The `introduction` field introduces the quick start and lists the tasks within it.

In the web console, after you click a quick start card, a side panel slides in that introduces the quick start and lists the tasks within it.

image::quick-start-introduction.png[quick start introduction element in the web console]
