_config.yml

# Welcome to Jekyll!
#
# This config file is meant for settings that affect your whole blog, values
# which you are expected to set up once and rarely edit after that. If you find
# yourself editing this file very often, consider using Jekyll's data files
# feature for the data you need to update frequently.
#
# For technical reasons, this file is *NOT* reloaded automatically when you use
# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
#
# If you need help with YAML syntax, here are some quick references for you:
# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
# https://learnxinyminutes.com/docs/yaml/
#
# Site settings
# These are used to personalize your new site. If you look in the HTML files,
# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
# You can create any custom variable you would like, and they will be accessible
# in the templates via {{ site.myvariable }}.

title: SwimOS Documentation
company: Nstream
company_website: https://nstream.io
email: your-email@example.com
description: >- # this means to ignore newlines until "baseurl:"
  SwimOS is an open source application platform that delivers the fastest 
  way to build real-time streaming data applications. Build stateful microservices, 
  streaming APIs, real-time UIs, and more.
baseurl: "" # the subpath of your site, e.g. /blog
url: "https://www.swimos.org" # the base hostname & protocol for your site, e.g. http://example.com
github_repository: https://github.com/swimos/swimos-docs
permalink: none
destination: _site

# SwimOS / JS Versions
swim-server-version: 4.2.14
swim-js-version: 4.0.0

postcss:
  cache: false

# Build settings
plugins:
  - jekyll-feed
  - jekyll-seo-tag
  - jekyll-postcss
  - jekyll-toc
  - jekyll-redirect-from
  - jekyll-sitemap
  - jekyll-paginate

# Exclude from processing.
# The following items will not be processed, by default.
# Any item listed under the `exclude:` key here will be automatically added to
# the internal "default list".
#
# Excluded items can be processed by explicitly listing the directories or
# their entries' file path in the `include:` list.
#
exclude:
  - .sass-cache/
  - .idea
  - .jekyll-cache/
  - .ruby-version
  - gemfiles/
  - Gemfile
  - Gemfile.lock
  - node_modules/
  - vendor/bundle/
  - vendor/cache/
  - vendor/gems/
  - vendor/ruby/
  - docker
  - docker-compose.yml
  - Jenkinsfile
  - s3_website.yml

# Every top level section is actually a collection. Their files are in a _folder in src/
collections:
  # Server Documentation
  swimos-concepts:
    kind: docs
    output: true
    name: "Java Server Getting Started"
    description: Getting started guide
    permalink: /swimos-concepts/:name/
    order:
      - index.md
      - fundamentals.md
      - why-swimos.md
      - web-agents-intro.md
      - lanes-intro.md
      - links-intro.md
      - recon.md
      - warp.md
  java-server-devguide:
    kind: docs
    output: true
    name: "Developer Guide"
    description: Step by step guide through SwimOS (Java).
    permalink: /server/java/developer-guide/:name/
    order:
      - index.md
      # 1. Introduction
      - 1-introduction.md
      # 2. Getting Started
      - 2-getting-started.md
      - 2.1-swim-create.md
      - 2.2-project-setup.md
      - 2.3-hello-world.md
      - 2.4-hello-agent.md
      - 2.5-hello-lane.md
      # 3. Agents
      # 3.1 Agent Details (parallel, atomic, no constructor, logging)
      # 3.1 Agent URIs
      # 3.2 Agent Properties
      # 3.3 Traits

  rust-server-devguide:
    kind: docs
    output: true
    name: "Developer Guide"
    description: Step by step guide through SwimOS (Rust).
    permalink: /server/rust/developer-guide/:name/
    order:
      - index.md
      - 1-getting-started.md
      - 2-simple-agent.md
      - 3-client.md
      - 4-agent-lifecycle.md
      - 5-custom-types.md
  java-server-tutorials:
    kind: docs
    output: true
    name: "Tutorials"
    description: Java Tutorials
    permalink: /server/java/tutorials/:name/
    order:
      - index.md
      - demos.md
      - transit.md
      - monitor.md
  java-server:
    kind: docs
    output: true
    name: "Java Server"
    description: Java server docs
    permalink: /server/java/:name/
    order:
      - index.md
      - swim-libraries.md
      # Design Guidelines
      - agent-design.md
      - lane-organization.md
      # Swim App Templates
      - time-series.md
      - summary-statistics.md
      - aggregations.md
      - agent-auth.md
      # Data Ingestion
      - kafka-ingestion.md
      - pulsar-ingestion.md
      - mongodb-ingestion.md
      - flink-connector.md
      - jms-ingestion.md
      - http-ingestion.md
      # Utilities
      - cli.md
      - swim-create.md
      - introspection.md
      # Reference
      - web-agents.md
      - lanes.md
      - command-lanes.md
      - value-lanes.md
      - map-lanes.md
      - join-value-lanes.md
      - join-map-lanes.md
      - demand-value-lanes.md
      - demand-map-lanes.md
      - planes.md
      - traits.md
      - downlinks.md
      - server-downlinks.md
      - forms.md
      - timers.md
      - ingress-bridges.md
      - egress-bridges.md
      - http-lanes.md
      - auth-policy.md
  # Rust Server
  rust-server:
    kind: docs
    output: true
    name: "Rust Server"
    description: Documentation for SwimOS Java Client
    permalink: /server/rust/:name/
    order:
      - index.md
  rust-server-devguide:
    kind: docs
    output: true
    name: "Rust Server Dev Guide"
    description: Documentation for SwimOS Java Client
    permalink: /server/rust/developer-guide/:name/
    order:
      - index.md
  rust-server-tutorials:
    kind: docs
    output: true
    name: "Rust Server Tutorials"
    description: Documentation for SwimOS Java Client
    permalink: /server/rust/tutorials/:name/
    order:
      - index.md
  # Client Docs
  typescript-client:
    kind: docs
    output: true
    name: "Client"
    description: Documentation about streaming data from SwimOS apps for use in UIs.
    permalink: /client/typescript/:name/
    order:
      - index.md
      # Introduction
      - what-is-warp.md
      - getting-started.md
      # Connections
      - warp-client.md
      - downlinks.md
      - value-downlink.md
      - map-downlink.md
      # - list-downlink.md
      - event-downlink.md
      # - property.md
      # - demand-lanes.md
      # - authentication.md
      # Data
      - data-model.md
      - structures.md
      - form.md
      # - structures.md
      # Examples/Demos
      # Integrations
      # - react.md
    # Client Docs
  python-client:
    kind: docs
    output: true
    name: "Python Client"
    description: Documentation for SwimOS Python Client
    permalink: /client/python/:name/
    order:
      - index.md
      # Introduction
      - what-is-warp.md
      - getting-started.md
      # Connections
      - swim-client.md
      - downlinks.md
      - value-downlink.md
      - map-downlink.md
      - event-downlink.md
  java-client:
    kind: docs
    output: true
    name: "Java Client"
    description: Documentation for SwimOS Java Client
    permalink: /client/java/:name/
    order:
      - index.md
  rust-client:
    kind: docs
    output: true
    name: "Rust Client"
    description: Documentation for SwimOS Java Client
    permalink: /client/rust/:name/
    order:
      - index.md
  meta:
    output: true
    name: "Meta"
    order:
      - index.md
      - contribute.md
      - diataxis.md
      - styles.md

# The directory that contains our collections
collections_dir: src

defaults:
  - scope:
      path: ""
      type: "posts"
    values:
      layout: "post"
      permalink: "/blog/:year/:i_month/:i_day/:title/"
      author: "swim"
      toc: false
  - scope:
      path: ""
    values:
      toc: true

# jekyll-toc Config
toc:
  list_id: toc # id of the <ul> for the toc
  list_class: mt-1 px-2 # We use TailwindCSS classes but you can also create your own
  sublist_class: "" # We use TailwindCSS classes but you can also create your own
  item_class: hover:text-swim-blue block rounded-md py-2 pr-2 pl-9 text-sm leading-6 text-swim-body-text # You guessed it, more TailwindCSS classes.
  item_prefix: toc- # Adds a toc-* class to each list item for styling. Ex. toc-h2 for list items that refer to an h2 in the doc body.

# Set display to true/false to toggle announcements on/off
# If developing locally, this requires a jekyll serve restart to test.
announcement:
  display: false
  cta: "Join us at StreamCon 2023!"
  text: "We'll be at booth #9001."
  cta-link: "https://nstream.io/"

# feed:
#   collections:
#     - tutorials
#     - server
#     - meta

paginate: 9
paginate_path: "/blog/page/:num"