SRVCOM-1288 + SRVCOM-1664: Clean up attributes, prereqs

Author: abrennan89

_topic_maps/_topic_map.yml

@@ -3228,6 +3228,8 @@ Topics:
     File: serverless-event-sinks
   - Name: Event delivery
     File: serverless-event-delivery
+  - Name: Listing event sources and event source types
+    File: serverless-listing-event-sources
   - Name: Creating an API server source
     File: serverless-apiserversource
   - Name: Creating a ping source
@@ -3335,7 +3337,7 @@ Topics:
     File: serverless-functions-eventing
   - Name: Function project configuration in func.yaml
     File: serverless-functions-yaml
-  - Name: Accessing secrets and config maps from Serverless functions
+  - Name: Accessing secrets and config maps from functions
     File: serverless-functions-accessing-secrets-configmaps
   - Name: Adding annotations to functions
     File: serverless-functions-annotations
@@ -3358,15 +3360,13 @@ Topics:
 - Name: Reference
   Dir: reference
   Topics:
-  - Name: kn flags reference
+  - Name: Knative CLI flags
     File: kn-flags-reference
   - Name: Knative Serving CLI commands
     File: kn-serving-ref
   - Name: Knative Eventing CLI commands
     File: kn-eventing-ref
-  - Name: Listing event sources and event source types
-    File: serverless-listing-event-sources
-  - Name: kn func
+  - Name: Functions commands
     File: kn-func-ref
   - Name: kn event
     File: kn-event-ref

modules/apiserversource-kn.adoc

@@ -1,6 +1,7 @@
 // Module included in the following assemblies:
 //
-// serverless/develop/serverless-apiserversource.adoc
+// * serverless/develop/serverless-apiserversource.adoc
+// * serverless/reference/kn-eventing-ref.adoc
 
 :_content-type: PROCEDURE
 [id="apiserversource-kn_{context}"]

modules/creating-serverless-apps-kn.adoc

@@ -1,6 +1,7 @@
 // Module included in the following assemblies:
 //
 // * serverless/develop/serverless-applications.adoc
+// * serverless/reference/kn-serving-ref.adoc
 
 :_content-type: PROCEDURE
 [id="creating-serverless-apps-kn_{context}"]
@@ -12,6 +13,7 @@ The following procedure describes how you can create a basic serverless applicat
 
 * {ServerlessOperatorName} and Knative Serving are installed on your cluster.
 * You have installed the `kn` CLI.
+* You have created a project or have access to a project with the appropriate roles and permissions to create applications and other workloads in {product-title}.
 
 .Procedure
 

modules/serverless-connect-sink-source-odc.adoc

@@ -1,6 +1,7 @@
 // Module included in the following assemblies:
 //
 // * serverless/develop/serverless-event-sinks.adoc
+// * serverless/functions/serverless-functions-eventing.adoc
 
 :_content-type: PROCEDURE
 [id="serverless-connect-sink-source-odc_{context}"]
@@ -10,8 +11,6 @@ You can create multiple event source types in {product-title} that can be connec
 
 .Prerequisites
 
-To connect an event source to a sink using the *Developer* perspective, ensure that:
-
 * The {ServerlessOperatorName}, Knative Serving, and Knative Eventing are installed on your {product-title} cluster.
 * You have created a sink.
 * You have logged in to the web console and are in the *Developer* perspective.
@@ -20,12 +19,15 @@ To connect an event source to a sink using the *Developer* perspective, ensure t
 .Procedure
 
 . Create an event source of any type, by navigating to *+Add* -> *Event Sources* and then selecting the event source type that you want to create.
+
 . In the *Sink* section of the *Event Sources* form view, select *Resource*. Then use the drop-down list to select your sink.
+
 . Click *Create*.
 
 .Verification
 
 You can verify that the event source was created and is connected to the sink by viewing the *Topology* page.
 
 . In the *Developer* perspective, navigate to *Topology*.
+
 . View the event source and click on the connected sink to see the sink details in the side panel.

modules/serverless-create-domain-mapping-kn.adoc

@@ -1,6 +1,7 @@
 // Module included in the following assemblies:
 //
 // * serverless/security/serverless-custom-domains.adoc
+// * serverless/reference/kn-serving-ref.adoc
 
 :_content-type: PROCEDURE
 [id="serverless-create-domain-mapping-kn_{context}"]
@@ -22,6 +23,7 @@ If a prefix is not provided when using the `--ref` flag, it is assumed that the
 Your custom domain must point to the DNS of the {product-title} cluster.
 ====
 * You have installed the `kn` CLI tool.
+* You have created a project or have access to a project with the appropriate roles and permissions to create applications and other workloads in {product-title}.
 
 .Procedure
 

modules/serverless-create-func-kn.adoc

@@ -1,6 +1,7 @@
 // Module included in the following assemblies:
 //
 // * serverless/functions/serverless-functions-getting-started.adoc
+// * serverless/reference/kn-func-ref.adoc
 
 :_content-type: PROCEDURE
 [id="serverless-create-func-kn_{context}"]

modules/serverless-functions-adding-annotations.adoc

@@ -1,7 +1,19 @@
+// Module included in the following assemblies:
+//
+// * serverless/functions/serverless-functions-annotations.adoc
+
 :_content-type: PROCEDURE
 [id="serverless-functions-adding-annotations_{context}"]
 = Adding annotations to a function
 
+You can use the following procedure to add annotations to a function.
+
+.Prerequisites
+
+* The {ServerlessOperatorName} and Knative Serving are installed on the cluster.
+* You have installed the `kn` CLI.
+* You have created a function.
+
 .Procedure
 
 . Open the `func.yaml` file for your function.

modules/serverless-functions-all-values-in-configmap-to-env-variables.adoc

@@ -1,6 +1,20 @@
+// Module included in the following assemblies:
+//
+// * serverless/functions/serverless-functions-accessing-secrets-configmaps.adoc
+
 [id="serverless-functions-all-values-in-configmap-to-env-variables_{context}"]
 = Setting environment variables from all values defined in a config map
 
+You can use the following procedure to set an environment variable from all values defined in a config map.
+
+.Prerequisites
+
+* The {ServerlessOperatorName} and Knative Serving are installed on the cluster.
+* You have installed the `kn` CLI.
+* You have created a function.
+
+.Procedure
+
 . Open the `func.yaml` file for your function.
 
 . For every config map for which you want to import all key-value pairs as environment variables, add the following YAML to the `envs` section:

modules/serverless-functions-all-values-in-secret-to-env-variables.adoc

@@ -1,6 +1,21 @@
+// Module included in the following assemblies:
+//
+// * serverless/functions/serverless-functions-accessing-secrets-configmaps.adoc
+
+:_content-type: PROCEDURE
 [id="serverless-functions-all-values-in-secret-to-env-variables_{context}"]
 = Setting environment variables from all values defined in a secret
 
+You can use the following procedure to set an environment variable from all values defined in a secret.
+
+.Prerequisites
+
+* The {ServerlessOperatorName} and Knative Serving are installed on the cluster.
+* You have installed the `kn` CLI.
+* You have created a function.
+
+.Procedure
+
 . Open the `func.yaml` file for your function.
 
 . For every secret for which you want to import all key-value pairs as environment variables, add the following YAML to the `envs` section:

modules/serverless-functions-func-yaml-environment-variables.adoc

@@ -1,9 +1,15 @@
+// Module included in the following assemblies:
+//
+// * serverless/functions/serverless-functions-yaml.adoc
+
 :_content-type: PROCEDURE
 [id="serverless-functions-func-yaml-environment-variables_{context}"]
 = Referencing local environment variables from func.yaml fields
 
 In the `envs` field in the `func.yaml`, you can put a reference to an environment variable available in the local environment. This can be useful for avoiding storing sensitive information, such as an API key in the function configuration.
 
+// no prereqs?
+
 .Procedure
 
 * To refer to a local environment variable, use the following syntax:
@@ -17,6 +23,7 @@ Substitute `ENV_VAR` with the name of the variable in the local environment that
 +
 For example, you might have the `API_KEY` variable available in the local environment. You can assign its value to the `MY_API_KEY` variable, which you can then directly use within your function:
 +
+.Example function
 [source,yaml]
 ----
 name: test
@@ -26,4 +33,5 @@ runtime: go
 envs:
 - name: MY_API_KEY
   value: '{{ env:API_KEY }}'
+...
 ----