SRVCOM-2114 restructure CLI

gabriel-rh · gabriel-rh · commit 1e45e6e165e2 · 2023-03-02T12:14:53.000Z
diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -3978,7 +3978,7 @@ Topics:
     Dir: kn-event-plugin
     Topics:
     - Name: Knative CLI plugins
-      File: kn-plugins
+      File: kn-plugins-events
 # Functions
 - Name: Functions
   Dir: functions
@@ -4009,14 +4009,31 @@ Topics:
 - Name: Knative CLI
   Dir: cli_tools
   Topics:
-  - Name: Configuring the Knative CLI
-    File: advanced-kn-config
-  - Name: Knative Serving CLI commands
-    File: kn-serving-ref
-  - Name: Knative Eventing CLI commands
-    File: kn-eventing-ref
-  - Name: Functions commands
-    File: kn-func-ref
+    - Name: Knative Serving CLI commands
+      Dir: serving_cli
+      Topics:
+      - Name: kn service commands
+        File: kn-service
+      - Name: kn service commands in offline mode
+        File: kn-service-offline
+      - Name: kn container commands
+        File: kn-container
+      - Name: kn domain commands
+        File: kn-domain
+    - Name: Configuring the Knative CLI
+      File: advanced-kn-config
+    - Name: Knative CLI plugins
+      File: kn-plugins
+    - Name: Knative Eventing CLI commands
+      Dir: eventing_cli
+      Topics:
+        - Name: kn source commands
+          File: kn-source
+    - Name: Knative Functions CLI commands
+      Dir: functions_cli
+      Topics:
+        - Name: kn functions commands
+          File: kn-functions
 # Admin guide
 - Name: Administer
   Dir: admin_guide
diff --git a/_topic_maps/_topic_map_osd.yml b/_topic_maps/_topic_map_osd.yml
@@ -595,7 +595,7 @@ Topics:
     Dir: kn-event-plugin
     Topics:
     - Name: Knative CLI plugins
-      File: kn-plugins
+      File: kn-plugins-events
 - Name: Functions
   Dir: functions
   Topics:
@@ -619,17 +619,35 @@ Topics:
     File: serverless-functions-annotations
   - Name: Functions development reference guide
     File: serverless-functions-reference-guide
+# Knative kn CLI
 - Name: Knative CLI
   Dir: cli_tools
   Topics:
-  - Name: Configuring the Knative CLI
-    File: advanced-kn-config
-  - Name: Knative Serving CLI commands
-    File: kn-serving-ref
-  - Name: Knative Eventing CLI commands
-    File: kn-eventing-ref
-  - Name: Functions commands
-    File: kn-func-ref
+    - Name: Knative Serving CLI commands
+      Dir: serving_cli
+      Topics:
+      - Name: kn service commands
+        File: kn-service
+      - Name: kn service commands in offline mode
+        File: kn-service-offline
+      - Name: kn container commands
+        File: kn-container
+      - Name: kn domain commands
+        File: kn-domain
+    - Name: Configuring the Knative CLI
+      File: advanced-kn-config
+    - Name: Knative CLI plugins
+      File: kn-plugins
+    - Name: Knative Eventing CLI commands
+      Dir: eventing_cli
+      Topics:
+        - Name: kn source commands
+          File: kn-source
+    - Name: Knative Functions CLI commands
+      Dir: functions_cli
+      Topics:
+        - Name: kn functions commands
+          File: kn-functions
 - Name: Administer
   Dir: admin_guide
   Topics:
diff --git a/_topic_maps/_topic_map_rosa.yml b/_topic_maps/_topic_map_rosa.yml
@@ -783,7 +783,7 @@ Topics:
     Dir: kn-event-plugin
     Topics:
     - Name: Knative CLI plugins
-      File: kn-plugins
+      File: kn-plugins-events
 - Name: Functions
   Dir: functions
   Topics:
@@ -807,17 +807,35 @@ Topics:
     File: serverless-functions-annotations
   - Name: Functions development reference guide
     File: serverless-functions-reference-guide
+# Knative kn CLI
 - Name: Knative CLI
   Dir: cli_tools
   Topics:
-  - Name: Configuring the Knative CLI
-    File: advanced-kn-config
-  - Name: Knative Serving CLI commands
-    File: kn-serving-ref
-  - Name: Knative Eventing CLI commands
-    File: kn-eventing-ref
-  - Name: Functions commands
-    File: kn-func-ref
+    - Name: Knative Serving CLI commands
+      Dir: serving_cli
+      Topics:
+      - Name: kn service commands
+        File: kn-service
+      - Name: kn service commands in offline mode
+        File: kn-service-offline
+      - Name: kn container commands
+        File: kn-container
+      - Name: kn domain commands
+        File: kn-domain
+    - Name: Configuring the Knative CLI
+      File: advanced-kn-config
+    - Name: Knative CLI plugins
+      File: kn-plugins
+    - Name: Knative Eventing CLI commands
+      Dir: eventing_cli
+      Topics:
+        - Name: kn source commands
+          File: kn-source
+    - Name: Knative Functions CLI commands
+      Dir: functions_cli
+      Topics:
+        - Name: kn functions commands
+          File: kn-functions
 - Name: Administer
   Dir: admin_guide
   Topics:
diff --git a/serverless/cli_tools/eventing_cli/_attribute b/serverless/cli_tools/eventing_cli/_attribute
@@ -0,0 +1 @@
+../../../_attributes/
diff --git a/serverless/cli_tools/eventing_cli/images b/serverless/cli_tools/eventing_cli/images
@@ -0,0 +1 @@
+../../../images
diff --git a/serverless/cli_tools/eventing_cli/kn-source.adoc b/serverless/cli_tools/eventing_cli/kn-source.adoc
@@ -0,0 +1,16 @@
+:_content-type: ASSEMBLY
+[id="kn-source"]
+= kn source commands
+include::_attributes/common-attributes.adoc[]
+:context: kn-source
+
+toc::[]
+
+You can use the following commands to list, create, and manage Knative event sources.
+
+include::modules/serverless-list-source-types-kn.adoc[leveloffset=+1]
+include::modules/specifying-sink-flag-kn.adoc[leveloffset=+1]
+include::modules/serverless-kn-containersource.adoc[leveloffset=+1]
+include::modules/apiserversource-kn.adoc[leveloffset=+1]
+include::modules/serverless-pingsource-kn.adoc[leveloffset=+1]
+include::modules/serverless-kafka-source-kn.adoc[leveloffset=+1]
diff --git a/serverless/cli_tools/eventing_cli/modules b/serverless/cli_tools/eventing_cli/modules
@@ -0,0 +1 @@
+../../../modules/
diff --git a/serverless/cli_tools/eventing_cli/snippets b/serverless/cli_tools/eventing_cli/snippets
@@ -0,0 +1 @@
+../../../snippets
diff --git a/serverless/cli_tools/functions_cli/_attribute b/serverless/cli_tools/functions_cli/_attribute
@@ -0,0 +1 @@
+../../../_attributes/
diff --git a/serverless/cli_tools/functions_cli/images b/serverless/cli_tools/functions_cli/images
@@ -0,0 +1 @@
+../../../images
diff --git a/serverless/cli_tools/functions_cli/kn-functions.adoc b/serverless/cli_tools/functions_cli/kn-functions.adoc
@@ -1,8 +1,8 @@
 :_content-type: ASSEMBLY
-[id="kn-func-ref"]
-= Functions commands
 include::_attributes/common-attributes.adoc[]
-:context: kn-func-ref
+[id="kn-functions"]
+= kn functions commands
+:context: kn-functions
 
 toc::[]
 
diff --git a/serverless/cli_tools/functions_cli/modules b/serverless/cli_tools/functions_cli/modules
@@ -0,0 +1 @@
+../../../modules/
diff --git a/serverless/cli_tools/functions_cli/snippets b/serverless/cli_tools/functions_cli/snippets
@@ -0,0 +1 @@
+../../../snippets
diff --git a/serverless/cli_tools/kn-eventing-ref.adoc b/serverless/cli_tools/kn-eventing-ref.adoc
diff --git a/serverless/cli_tools/kn-plugins.adoc b/serverless/cli_tools/kn-plugins.adoc
diff --git a/serverless/cli_tools/kn-serving-ref.adoc b/serverless/cli_tools/kn-serving-ref.adoc
diff --git a/serverless/cli_tools/serving_cli/_attributes b/serverless/cli_tools/serving_cli/_attributes
@@ -0,0 +1 @@
+../../../_attributes/
diff --git a/serverless/cli_tools/serving_cli/images b/serverless/cli_tools/serving_cli/images
@@ -0,0 +1 @@
+../../../images
diff --git a/serverless/cli_tools/serving_cli/kn-container.adoc b/serverless/cli_tools/serving_cli/kn-container.adoc
@@ -0,0 +1,11 @@
+:_content-type: ASSEMBLY
+include::_attributes/common-attributes.adoc[]
+[id="kn-container"]
+= kn container commands
+:context: kn-container
+
+toc::[]
+
+You can use the following commands to create and manage multiple containers in a Knative service spec.
+
+include::modules/serverless-kn-container.adoc[leveloffset=+1]
diff --git a/serverless/cli_tools/serving_cli/kn-domain.adoc b/serverless/cli_tools/serving_cli/kn-domain.adoc
@@ -0,0 +1,12 @@
+:_content-type: ASSEMBLY
+include::_attributes/common-attributes.adoc[]
+[id="kn-domain"]
+= kn domain commands
+:context: kn-domain
+
+toc::[]
+
+You can use the following commands to create and manage domain mappings.
+
+include::modules/serverless-create-domain-mapping-kn.adoc[leveloffset=+1]
+include::modules/serverless-manage-domain-mapping-kn.adoc[leveloffset=+1]
diff --git a/serverless/cli_tools/serving_cli/kn-service-offline.adoc b/serverless/cli_tools/serving_cli/kn-service-offline.adoc
@@ -0,0 +1,11 @@
+:_content-type: ASSEMBLY
+include::_attributes/common-attributes.adoc[]
+[id="kn-service-offline"]
+= kn service commands in offline mode
+:context: kn-service-offline
+
+toc::[]
+
+// offline mode
+include::modules/kn-service-offline-about.adoc[leveloffset=+1]
+include::modules/kn-service-offline-create.adoc[leveloffset=+1]
diff --git a/serverless/cli_tools/serving_cli/kn-service.adoc b/serverless/cli_tools/serving_cli/kn-service.adoc
@@ -0,0 +1,15 @@
+:_content-type: ASSEMBLY
+include::_attributes/common-attributes.adoc[]
+[id="kn-service"]
+= kn service commands
+:context: kn-service
+
+toc::[]
+
+You can use the following commands to create and manage Knative services.
+
+
+include::modules/creating-serverless-apps-kn.adoc[leveloffset=+1]
+include::modules/kn-service-update.adoc[leveloffset=+1]
+include::modules/kn-service-apply.adoc[leveloffset=+1]
+include::modules/kn-service-describe.adoc[leveloffset=+1]
diff --git a/serverless/cli_tools/serving_cli/modules b/serverless/cli_tools/serving_cli/modules
@@ -0,0 +1 @@
+../../../modules/
diff --git a/serverless/cli_tools/serving_cli/snippets b/serverless/cli_tools/serving_cli/snippets
@@ -0,0 +1 @@
+../../../snippets
diff --git a/serverless/eventing/kn-event-plugin/kn-plugins-events.adoc b/serverless/eventing/kn-event-plugin/kn-plugins-events.adoc
@@ -0,0 +1,17 @@
+:_content-type: ASSEMBLY
+include::_attributes/common-attributes.adoc[]
+[id="kn-plugins-events"]
+= Knative CLI plugins
+:context: kn-plugins-events
+
+toc::[]
+
+The Knative (`kn`) CLI supports the use of plugins, which enable you to extend the functionality of your `kn` installation by adding custom commands and other shared commands that are not part of the core distribution. Knative (`kn`) CLI plugins are used in the same way as the main `kn` functionality.
+
+Currently, Red Hat supports the `kn-source-kafka` plugin and the `kn-event` plugin.
+
+:FeatureName: The `kn-event` plugin
+include::snippets/technology-preview.adoc[leveloffset=+1]
+// kn event commands
+include::modules/serverless-build-events-kn.adoc[leveloffset=+1]
+include::modules/serverless-send-events-kn.adoc[leveloffset=+1]
diff --git a/serverless/knative-serving/getting-started/serverless-applications.adoc b/serverless/knative-serving/getting-started/serverless-applications.adoc
@@ -35,5 +35,5 @@ include::modules/kn-service-offline-create.adoc[leveloffset=+1]
 [id="additional-resources_serverless-applications"]
 [role="_additional-resources"]
 == Additional resources
-* xref:../../../serverless/cli_tools/kn-serving-ref.adoc#kn-serving-ref[Knative Serving CLI commands]
+* xref:../../../serverless/cli_tools/serving_cli/kn-service.adoc#kn-service[Knative Serving CLI commands]
 * xref:../../../serverless/knative-serving/config-access/serverless-ossm-with-kourier-jwt.adoc#serverless-ossm-with-kourier-jwt[Configuring JSON Web Token authentication for Knative services]
