Skip to content

Commit 024b635

Browse files
abrennan89abrennan89
authored
Merge pull request #40094 from abrennan89/573
SRVCOM-1580: docs cleanup
2 parents 2895f30 + 759882b commit 024b635

File tree

11 files changed

+73
-93
lines changed

11 files changed

+73
-93
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3126,6 +3126,8 @@ Topics:
31263126
- Name: Discover
31273127
Dir: discover
31283128
Topics:
3129+
- Name: About OpenShift Serverless
3130+
File: about-serverless
31293131
- Name: Understanding Knative Eventing
31303132
File: serverless-understanding-eventing
31313133
- Name: Understanding Knative Serving
@@ -3141,13 +3143,11 @@ Topics:
31413143
File: installing-knative-eventing
31423144
- Name: Removing OpenShift Serverless
31433145
File: removing-openshift-serverless
3144-
- Name: Get started
3145-
File: serverless-getting-started
3146+
#- Name: Get started
3147+
# File: serverless-getting-started
3148+
# uncomment once new content is added for this
31463149
- Name: Update
3147-
Dir: update
3148-
Topics:
3149-
- Name: Upgrading the OpenShift Serverless Operator
3150-
File: upgrading-serverless
3150+
File: serverless-update
31513151
- Name: Develop
31523152
Dir: develop
31533153
Topics:

‎cli_reference/kn-cli-tools.adoc

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,13 @@
11
include::modules/serverless-document-attributes.adoc[]
22
[id="kn-cli-tools"]
3-
= Knative CLI (kn) for use with OpenShift Serverless
3+
= Knative CLI (kn) for use with {ServerlessProductName}
44
:context: kn-cli-tools
55
include::modules/common-attributes.adoc[]
66

77
toc::[]
88

99
The Knative `kn` CLI enables simple interaction with Knative components on {product-title}.
1010

11-
You can enable Knative on {product-title} by installing {ServerlessProductName}. For more information, see xref:../serverless/serverless-getting-started.adoc#serverless-getting-started[Getting started with {ServerlessProductName}].
12-
13-
[NOTE]
14-
====
15-
{ServerlessProductName} cannot be installed using the `kn` CLI. A cluster administrator must install the {ServerlessOperatorName} and set up the Knative components, as described in the xref:../serverless/install/install-serverless-operator.adoc#install-serverless-operator[Serverless applications] documentation for {product-title}.
16-
====
17-
1811
[id="kn-cli-tools-key-features"]
1912
== Key features
2013

‎jaeger/jaeger_config/serverless-jaeger-integration.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ include::modules/common-attributes.adoc[]
66

77
toc::[]
88

9-
Using Jaeger with xref:../../serverless/serverless-getting-started.adoc#serverless-getting-started[{ServerlessProductName}] allows you to enable distributed tracing for your serverless applications on {product-title}.
9+
Using Jaeger with xref:../../serverless/discover/about-serverless.adoc#about-serverless[{ServerlessProductName}] allows you to enable distributed tracing for your serverless applications on {product-title}.
1010

1111
include::modules/serverless-jaeger-config.adoc[leveloffset=+1]

‎modules/serverless-apps-intro.adoc

Lines changed: 0 additions & 34 deletions
This file was deleted.

‎serverless/cli_tools/installing-kn.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,14 @@ include::modules/common-attributes.adoc[]
66

77
toc::[]
88

9-
The Knative CLI (`kn`) does not have its own login mechanism. To log in to the cluster, you must install the `oc` CLI and use the `oc login` command.
9+
Installation options for the `oc` CLI may vary depending on your operating system.
1010

11-
Installation options for the `oc` CLI will vary depending on your operating system.
11+
The Knative CLI (`kn`) does not have its own login mechanism. To log in to the cluster, you must install the `oc` CLI and use the `oc login` command.
1212

1313
For more information on installing the `oc` CLI for your operating system and logging in with `oc`, see the xref:../../cli_reference/openshift_cli/getting-started-cli.adoc#cli-getting-started[OpenShift CLI getting started] documentation.
1414

15+
{ServerlessProductName} cannot be installed using the `kn` CLI. A cluster administrator must install the {ServerlessOperatorName} and set up the Knative components, as described in the xref:../../serverless/install/install-serverless-operator.adoc#install-serverless-operator[Installing the {ServerlessOperatorName}] documentation.
16+
1517
[IMPORTANT]
1618
====
1719
If you try to use an older version of the Knative `kn` CLI with a newer {ServerlessProductName} release, the API is not found and an error occurs.

‎serverless/develop/serverless-applications.adoc

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,30 @@ include::modules/common-attributes.adoc[]
66

77
toc::[]
88

9-
include::modules/serverless-apps-intro.adoc[leveloffset=+1]
9+
To deploy a serverless application using {ServerlessProductName}, you must create a _Knative service_. Knative services are Kubernetes services, defined by a route and a configuration, and contained in a YAML file.
10+
11+
.Example Knative service YAML
12+
[source,yaml]
13+
----
14+
apiVersion: serving.knative.dev/v1
15+
kind: Service
16+
metadata:
17+
name: hello <1>
18+
namespace: default <2>
19+
spec:
20+
template:
21+
spec:
22+
containers:
23+
- image: docker.io/openshift/hello-openshift <3>
24+
env:
25+
- name: RESPONSE <4>
26+
value: "Hello Serverless!"
27+
----
28+
29+
<1> The name of the application.
30+
<2> The namespace the application uses.
31+
<3> The image of the application.
32+
<4> The environment variable printed out by the sample application.
1033

1134
[id="serverless-applications-create"]
1235
== Creating serverless applications
@@ -17,12 +40,6 @@ You can create a serverless application by using one of the following methods:
1740
* Create a Knative service using the `kn` CLI.
1841
* Create and apply a YAML file.
1942

20-
[id="serverless-applications-web-console"]
21-
=== Creating serverless applications using the {product-title} web console
22-
23-
For more information about creating applications using the *Developer* perspective in the {product-title} web console, see the documentation on xref:../../applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[Creating applications using the Developer perspective].
24-
25-
// TODO: Add admin perspective service docs
2643
// create service using CLI
2744
include::modules/creating-serverless-apps-kn.adoc[leveloffset=+2]
2845

‎serverless/discover/about-serverless.adoc

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
include::modules/serverless-document-attributes.adoc[]
2+
[id="about-serverless"]
3+
= About {ServerlessProductName}
4+
:context: about-serverless
5+
include::modules/common-attributes.adoc[]
6+
7+
toc::[]
8+
9+
Serverless is a cloud computing model where application developers do not need to provision servers or manage scaling for their applications. These routine tasks are abstracted away by the platform, allowing developers to push code to production more quickly than in traditional models.
10+
11+
{ServerlessProductName} simplifies the process of delivering code from development into production by reducing the need for infrastructure set up or back-end development by developers.
12+
13+
Developers on {ServerlessProductName} can use the provided Kubernetes native APIs, as well as familiar languages and frameworks, to deploy applications and container workloads.
14+
15+
{ServerlessProductName} is based on the open source link:https://knative.dev/docs/[Knative project], which provides portability and consistency for hybrid and multi-cloud environments by enabling an enterprise-grade serverless platform.
16+
17+
[id="about-serverless-supported-configs"]
18+
== Supported configurations
19+
20+
The set of supported features, configurations, and integrations for {ServerlessProductName}, current and past versions, are available at the link:https://access.redhat.com/articles/4912821[Supported Configurations page].

‎serverless/serverless-getting-started.adoc

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,3 @@ include::modules/serverless-document-attributes.adoc[]
55
include::modules/common-attributes.adoc[]
66

77
toc::[]
8-
9-
{ServerlessProductName} simplifies the process of delivering code from development into production by reducing the need for infrastructure set up or back-end development by developers.
10-
11-
Serverless is a cloud computing model where application developers do not need to provision servers or manage scaling for their applications. These routine tasks are abstracted away by the platform, allowing developers to push code to production more quickly than in traditional models.
12-
13-
[id="serverless-getting-started-how-it-works"]
14-
== How {ServerlessProductName} works
15-
16-
Developers on {ServerlessProductName} can use the provided Kubernetes native APIs, as well as familiar languages and frameworks, to deploy applications and container workloads.
17-
18-
{ServerlessProductName} on {product-title} enables stateless, serverless workloads to all run on a single multi-cloud container platform with automated operations. Developers can use a single platform for hosting their microservices, legacy, and serverless applications.
19-
20-
{ServerlessProductName} is based on the open source Knative project, which provides portability and consistency across hybrid and multi-cloud environments by enabling an enterprise-grade serverless platform.
21-
22-
[id="serverless-getting-started-supported-configs"]
23-
== Supported configurations
24-
25-
The set of supported features, configurations, and integrations for {ServerlessProductName}, current and past versions, are available at the link:https://access.redhat.com/articles/4912821[Supported Configurations page].

‎serverless/serverless-release-notes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ include::modules/common-attributes.adoc[]
66

77
toc::[]
88

9-
For an overview of {ServerlessProductName} functionality, see xref:../serverless/serverless-getting-started.adoc#serverless-getting-started[Getting started with OpenShift Serverless].
9+
For an overview of {ServerlessProductName} functionality, see xref:../serverless/discover/about-serverless.adoc#about-serverless[About {ServerlessProductName}].
1010

1111
[NOTE]
1212
====

‎serverless/serverless-update.adoc

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
include::modules/serverless-document-attributes.adoc[]
2+
[id="serverless-update"]
3+
= Update
4+
include::modules/common-attributes.adoc[]
5+
:context: serverless-update
6+
7+
toc::[]
8+
9+
If you have installed a previous version of {ServerlessProductName}, you can follow the instructions in this guide to update to the latest version.
10+
11+
[IMPORTANT]
12+
====
13+
If you have previously installed the community Knative Eventing Operator, you must remove this Operator before you are able to install the latest version of Knative Eventing by using the {ServerlessOperatorName}.
14+
====
15+
16+
include::modules/serverless-upgrade-sub-channel.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)