mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
48 lines
1.1 KiB
Plaintext
48 lines
1.1 KiB
Plaintext
// Module included in the following assemblies:
|
|
//
|
|
// * web_console/creating-quick-start-tutorials.adoc
|
|
|
|
:_mod-docs-content-type: PROCEDURE
|
|
[id="contributing-quick-starts_{context}"]
|
|
= Contributing quick starts
|
|
|
|
{product-title} introduces the quick start custom resource, which is defined by a `ConsoleQuickStart` object. Operators and administrators can use this resource to contribute quick starts to the cluster.
|
|
|
|
.Prerequisites
|
|
|
|
* You must have cluster administrator privileges.
|
|
|
|
.Procedure
|
|
|
|
. To create a new quick start, run:
|
|
+
|
|
[source,yaml]
|
|
----
|
|
$ oc get -o yaml consolequickstart spring-with-s2i > my-quick-start.yaml
|
|
----
|
|
|
|
. Run:
|
|
+
|
|
[source,yaml]
|
|
----
|
|
$ oc create -f my-quick-start.yaml
|
|
----
|
|
|
|
. Update the YAML file using the guidance outlined in this documentation.
|
|
|
|
. Save your edits.
|
|
|
|
[id="viewing-quick-start-api-documentation_{context}"]
|
|
== Viewing the quick start API documentation
|
|
|
|
.Procedure
|
|
|
|
* To see the quick start API documentation, run:
|
|
+
|
|
[source,terminal]
|
|
----
|
|
$ oc explain consolequickstarts
|
|
----
|
|
|
|
Run `oc explain -h` for more information about `oc explain` usage.
|