Small doc fixes

jeroenvandisseldorp · Jun 27, 2024 · 60971a5 · 60971a5
1 parent 336a765
commit 60971a5
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 15 deletions.
diff --git a/docs/_data/menu.yaml b/docs/_data/menu.yaml
@@ -24,4 +24,4 @@ items:
     url: runners.html
 
   - title: Language Specification
-    url: specification.html
+    url: ksml-language-spec.html
diff --git a/docs/functions.md b/docs/functions.md
@@ -30,7 +30,7 @@ functions:
       - name: secondParam
         type: int
     globalCode: |
-      import something from somepackage
+      import something from package
       globalVar = 3
     code: |
       print('Hello there!')

diff --git a/docs/pipelines.md b/docs/pipelines.md
@@ -74,7 +74,7 @@ four sink types in KSML:
 | `to`      | Sends all output messages to a specific target. This target can be a pre-defined `stream`, `table` or `globalTable`, an inline-defined topic, or a special function called a `topicNameExtractor`.                   |
 
 For more information, see the respective documentation on pipeline definitions in
-the [definitions section of the KSML language spec](ksml-language-spec.md#definitions).
+the [definitions section of the KSML language spec](ksml-language-spec.html#definitions/PipelineDefinition).
 
 ## Duration
 

diff --git a/docs/runners.md b/docs/runners.md
@@ -23,14 +23,14 @@ The configuration file passed to the KSML runner is in YAML format and should co
 
 ```yaml
 ksml:
-  applicationServer: # The application server is currently only offering REST querying of state stores
+  applicationServer:                           # The application server is currently only offering REST querying of state stores
     enabled: true                              # true if you want to enable REST querying of state stores
     host: 0.0.0.0                              # by default listen on all interfaces
     port: 8080                                 # port to listen on
   configDirectory: /ksml/config                # Location of the KSML definitions. Default is the current working directory
   schemaDirectory: /ksml/schemas               # Location of the schema definitions. Default is the config directory
   storageDirectory: /ksml/data                 # Where the stateful data is written. Defaults is the default JVM temp directory
-  errorHandling: # how to handle errors
+  errorHandling:                               # how to handle errors
     consume:
       log: true                                # log errors
       logPayload: true                         # log message payloads upon error
@@ -48,12 +48,12 @@ ksml:
       handler: continueOnFail                  # continue or stop on error
     enableProducers: true                      # False to disable producers in the KSML definition
     enablePipelines: true                      # False to disable pipelines in the KSML definition
-    definitions: # KSML definition files from the working directory
+    definitions:                               # KSML definition files from the working directory
       namedDefinition1: definition1.yaml
       namedDefinition2: definition2.yaml
       namedDefinition3: <more here...>
 
-kafka: # Kafka streams configuration options 
+kafka:                                         # Kafka streams configuration options 
   application.id: io.ksml.example.processor
   bootstrap.servers: broker-1:9092,broker-2:9092
   security.protocol: SSL

diff --git a/docs/types.md b/docs/types.md
@@ -3,14 +3,14 @@
 ### Table of Contents
 
 1. [Introduction](#introduction)
-1. [Primitives](#primitives)
-1. [Any](#any)
-1. [Duration](#duration)
-1. [Enum](#enum)
-1. [List](#list)
-1. [Struct](#struct)
-1. [Tuple](#tuple)
-1. [Windowed](#windowed)
+2. [Primitives](#primitives)
+3. [Any](#any)
+4. [Duration](#duration)
+5. [Enum](#enum)
+6. [List](#list)
+7. [Struct](#struct)
+8. [Tuple](#tuple)
+9. [Windowed](#windowed)
 
 ## Introduction