Skip to content

Commit a116b92

Browse files
committed
osdocs-86 add quickstart modules
1 parent 2a86727 commit a116b92

File tree

3 files changed

+56
-1
lines changed

3 files changed

+56
-1
lines changed

builds/using-templates.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ include::modules/templates-modifying-uploaded-template.adoc[leveloffset=+1]
2828

2929
include::modules/templates-using-instant-app-quickstart.adoc[leveloffset=+1]
3030

31+
include::modules/templates-quickstart.adoc[leveloffset=+2]
32+
3133
include::modules/templates-writing.adoc[leveloffset=+1]
3234

3335
include::modules/templates-writing-description.adoc[leveloffset=+2]

modules/templates-overview.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
// * assembly/builds
44

55
[id='templates-overview-{context}']
6-
= What is a template?
6+
= Understanding templates
77

88
A template describes a set of objects that can be parameterized and processed to
99
produce a list of objects for creation by {product-title}. A template can be

modules/templates-quickstart.adoc

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * assembly/builds
4+
5+
[id='templates-quickstart-{context}']
6+
= Quickstart templates
7+
8+
A Quickstart is a basic example of an application running on {product-title}.
9+
Quickstarts come in a variety of languages and frameworks, and are defined in a
10+
template, which is constructed from a set of services, build configurations, and
11+
deployment configurations. This template references the necessary images and
12+
source repositories to build and deploy the application.
13+
14+
To explore a Quickstart, create an application from a template. Your
15+
administrator may have already installed these templates in your {product-title}
16+
cluster, in which case you can simply select it from the web console.
17+
18+
Quickstarts refer to a source repository that contains the application source
19+
code. To customize the Quickstart, fork the repository and, when creating an
20+
application from the template, substitute the default source repository name
21+
with your forked repository. This results in builds that are performed using
22+
your source code instead of the provided example source. You can then update the
23+
code in your source repository and launch a new build to see the changes
24+
reflected in the deployed application.
25+
26+
== Web framework Quickstart templates
27+
28+
These Quickstart templates provide a basic application of the indicated
29+
framework and language:
30+
31+
* CakePHP: a PHP web framework (includes a MySQL database)
32+
* Dancer: a Perl web framework (includes a MySQL database)
33+
* Django: a Python web framework (includes a PostgreSQL database)
34+
* NodeJS: a NodeJS web application (includes a MongoDB database)
35+
* Rails: a Ruby web framework (includes a PostgreSQL database)
36+
37+
38+
39+
//* CakePHP: a PHP web framework (includes a MySQL database)
40+
//** link:https://github.com/openshift/origin/tree/master/examples/quickstarts/cakephp-mysql.json[Template definition]
41+
//** link:https://github.com/sclorg/cakephp-ex[Source repository]
42+
//* Dancer: a Perl web framework (includes a MySQL database)
43+
//** link:https://github.com/openshift/origin/tree/master/examples/quickstarts/dancer-mysql.json[Template definition]
44+
//** link:https://github.com/sclorg/dancer-ex[Source repository]
45+
//* Django: a Python web framework (includes a PostgreSQL database)
46+
//** link:https://github.com/openshift/origin/tree/master/examples/quickstarts/django-postgresql.json[Template definition]
47+
//** link:https://github.com/sclorg/django-ex[Source repository]
48+
//* NodeJS: a NodeJS web application (includes a MongoDB database)
49+
//** link:https://github.com/openshift/origin/tree/master/examples/quickstarts/nodejs-mongodb.json[Template definition]
50+
//** link:https://github.com/sclorg/nodejs-ex[Source repository]
51+
//* Rails: a Ruby web framework (includes a PostgreSQL database)
52+
//** link:https://github.com/openshift/origin/tree/master/examples/quickstarts/rails-postgresql.json[Template definition]
53+
//** link:https://github.com/sclorg/rails-ex[Source repository]

0 commit comments

Comments
 (0)