Port-4313 ocean documentation

.github/workflows/verify-docs-build.yml

@@ -0,0 +1,54 @@
+name: Verify Docs Build
+
+on:
+  pull_request:
+    types:
+      - "opened"
+      - "synchronize"
+      - "reopened"
+      - "ready_for_review"
+      - "converted_to_draft"
+
+concurrency:
+  group: ${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+    name: Test successful docs production build
+    defaults:
+      run:
+        working-directory: docs/framework-guides/
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          persist-credentials: true
+      - name: Install dependencies
+        uses: actions/setup-node@v3
+        with:
+          node-version: lts/*
+          cache: npm
+          cache-dependency-path: docs/framework-guides/package-lock.json
+      - run: npm ci
+      - name: Build
+        run: npm run build
+
+  build-api-docs:
+    runs-on: ubuntu-latest
+    name: Test successful api-docs production build
+    defaults:
+      run:
+        working-directory: docs/api-docs
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          persist-credentials: true
+      - name: Install dependencies
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+      - name: Make install and build
+        run: |
+          make install
+          make build

.yamllint.yaml

@@ -1,6 +1,10 @@
 extends: default
 
-ignore-from-file: [.gitignore, .yamlignore]
+ignore: |
+  **/node_modules/**
+  .gitignore
+  .yamlignore
+  **/{{cookiecutter.integration_slug}}/**
 
 rules:
   # ignore line length

CHANGELOG.md

@@ -7,8 +7,7 @@ this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 <!-- towncrier release notes start -->
 
-0.2.3 (2023-08-17)
-==================
+## 0.2.3 (2023-08-17)
 
 ### Features
 
@@ -26,24 +25,23 @@ this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 - Handled delete events from change log where there is no after
 
 
-0.2.2 (2023-08-11)
-==================
+## 0.2.2 (2023-08-11)
 
 ### Bug Fixes
 
 - Fixed an issue causing the config yaml providers to not be parsed
 
 
-0.2.1 (2023-08-09)
-==================
+## 0.2.1 (2023-08-09)
+
 
 ### Bug Fixes
 
 - Fixed an issue causing ocean to convert the integration config objects to camelized objects
 
 
-0.2.0 (2023-08-09)
-==================
+## 0.2.0 (2023-08-09)
+
 
 ### Breaking Changes
 
@@ -64,16 +62,16 @@ this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 - Fixed an issue that caused the jq `None` values for relations to become a string with the value `"None"` instead of being interpreted as `null` in JSON
 
 
-0.1.3 (2023-08-02)
-==================
+## 0.1.3 (2023-08-02)
+
 
 ### Bug Fixes
 
 - Fixed an issue preventing the setup of an integration with config values passed exclusively as environment variables. This fix also enables the option to deploy an integration to AWS ECS using Terraform (PORT-4379)
 
 
-0.1.2 (2023-07-27)
-==================
+## 0.1.2 (2023-07-27)
+
 
 ### Breaking Changes
 
@@ -94,8 +92,8 @@ this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 - Fixed a crash when there are no resources in the port-app-config
 
 
-0.1.1 (2023-07-26)
-==================
+## 0.1.1 (2023-07-26)
+
 
 ### Breaking Changes
 
@@ -117,8 +115,8 @@ this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 - Fixed an issue with initializePortResources that caused failure for unknown file names on init (PORT-4343)
 
 
-0.1.0 (2023-07-20)
-==================
+## 0.1.0 (2023-07-20)
+
 
 ### Features
 

docs/api-docs/Makefile

@@ -0,0 +1,55 @@
+ACTIVATE := . .venv/bin/activate
+
+define install_poetry
+	if ! command -v poetry &> /dev/null; then \
+    	pip install --upgrade pip; \
+		pip install poetry; \
+	else \
+    	echo "Poetry is already installed."; \
+	fi
+endef
+
+define deactivate_virtualenv
+    if [ -n "$$VIRTUAL_ENV" ]; then \
+        unset VIRTUAL_ENV; \
+        unset PYTHONHOME; \
+        unset -f pydoc >/dev/null 2>&1; \
+        OLD_PATH="$$PATH"; \
+        PATH=$$(echo -n "$$PATH" | awk -v RS=: -v ORS=: '/\/virtualenv\/bin$$/ {next} {print}'); \
+        export PATH; \
+        hash -r; \
+        echo "Deactivated the virtual environment."; \
+    fi
+endef
+
+.SILENT: install
+
+
+# Install dependencies
+install:
+	$(call deactivate_virtualenv) && \
+	$(call install_poetry) && \
+	poetry install --all-extras
+
+run:
+	$(ACTIVATE) && \
+	mkdocs serve -w ../../
+
+build:
+	$(ACTIVATE) && \
+	mkdocs build
+
+clean:
+	@find . -name '.venv' -type d -exec rm -rf {} \;
+	@find . -name '*.pyc' -exec rm -rf {} \;
+	@find . -name '__pycache__' -exec rm -rf {} \;
+	@find . -name 'Thumbs.db' -exec rm -rf {} \;
+	@find . -name '*~' -exec rm -rf {} \;
+	rm -rf .cache
+	rm -rf build
+	rm -rf dist
+	rm -rf *.egg-info
+	rm -rf htmlcov
+	rm -rf .tox/
+	rm -rf docs/_build
+	rm -rf dist/

docs/api-docs/mkdocs.yml

@@ -0,0 +1,115 @@
+site_name: Ocean API References
+site_url: https://app.getport.io
+theme:
+  name: material
+  logo: ./assets/OceanSymbol.svg
+  favicon: ./assets/OceanSymbol.svg
+  features:
+    - content.action.edit
+    - content.action.view
+    - content.code.annotate
+    - content.code.copy
+    - content.tooltips
+    - navigation.indexes
+    - navigation.top
+    - navigation.tracking
+    - search.highlight
+    - search.share
+    - search.suggest
+    - toc.follow
+    - navigation.tabs
+
+  palette:
+    - scheme: default
+      media: "(prefers-color-scheme: light)"
+      primary: teal
+      accent: indigo
+      toggle:
+        icon: material/lightbulb
+        name: Switch to dark mode
+    - scheme: slate
+      media: "(prefers-color-scheme: dark)"
+      primary: teal
+      accent: indigo
+      toggle:
+        icon: material/lightbulb-outline
+        name: Switch to light mode
+
+repo_name: port-labs/Port-Ocean
+repo_url: https://github.com/port-labs/Port-Ocean
+docs_dir: src
+
+# Plugins
+plugins:
+  - redirects:
+      redirect_maps:
+          'index.md': 'references/index.md'
+  - search:
+      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
+  - mkdocstrings:
+      handlers:
+        python:
+          paths: [../../port_ocean]
+          options:
+            show_root_heading: true
+            heading_level: 2
+            show_category_heading: true
+            show_source: false
+            show_bases: false
+
+markdown_extensions:
+  - admonition
+  - toc:
+      permalink: true
+  - codehilite:
+      linenums: True
+      guess_lang: false
+  - pymdownx.emoji:
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format ""
+  - pymdownx.tabbed:
+      alternate_style: true
+  - pymdownx.snippets:
+      base_path: ../
+  - attr_list:
+  - md_in_html:
+
+extra_css:
+  - assets/css/termynal.css
+  - assets/css/custom.css
+extra_javascript:
+  - assets/js/termynal.js
+  - assets/js/custom.js
+
+nav:
+   - 🔍 References:
+       - References: ./references/index.md
+       - core:
+           - integrations:
+               - ./references/core/integrations/index.md
+               - mixins: ./references/core/integrations/mixins.md
+           - handlers:
+               - entities_state_applier: ./references/core/handlers/entities-state-applier.md
+               - entity_processor: ./references/core/handlers/entity-processor.md
+               - port_app_config: ./references/core/handlers/port-app-config.md
+           - event_listener:
+               - ./references/core/event-listener/index.md
+               - polling: ./references/core/event-listener/polling.md
+               - kafka: ./references/core/event-listener/kafka.md
+               - http: ./references/core/event-listener/http.md
+           - models: ./references/core/models.md
+           - ocean_types: ./references/core/ocean-types.md
+       - clients: ./references/clients.md
+       - config: ./references/config.md
+       - consumers: ./references/consumers.md
+       - context: ./references/context.md
+       - middleware: ./references/middleware.md
+       - ocean: ./references/ocean.md
+       - run: ./references/run.md
+       - utils: ./references/utils.md
+   - 🌊 Ocean Guides: https://ocean.getport.io