-
Notifications
You must be signed in to change notification settings - Fork 73
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* docs initiation * docs improvement * a bit of reference docs * showing release notes and license * added build command * update * fixed the index file * name * docs * docs * updated the docs * fixed snippets * Some local changes * Update tree and complete index * Continue work on quickstart * Overhaul docs * Fix sidebar titles and order * Fix docs startup port * Added some api references and doc strings * moved the event listeners * removed unused md * Update pages and sidebar * Some mor fixes * Continue work on development docs * Continue work * Continue work on configuration apge * changelog and license * changelog * fixed conflicts * Finish the event listener page * faq first version * Fix typo * Add another section to integration configuration * more docs * Update FAQ * thumbnail * Update live events page * fixed faq links * fixed faq links * Update contexts page * fixed scss * fixed the contexts code * guidelines * guidelines * showing integration icon * showing integration icon * showing integration icon * guidlines * guidlines * guidlines * performance.md * initial triggering page * Add some more pages * badges * Complete spec.yml section * Remove unnecessary CSS * Complete spec page * Finish performance page * Updates guideliens page * Make some minor updates * sync page * sync page * Some fixes * resource mapping * resource mapping * api references tbd * fixed badges in the overview to link to the port-ocean * Added user-agent title * user agent doc * helm and tf pages * Remove emoji from all page titles * deployment methods * Finish resource mapping page * Finish sync page * Add TODO * Update header and footer * Complete user agent feature page * Finish deployment pages * removed termy * Fix codeblocks in getting started * fixed build * removed files * removed files * Fix issue in CI * Fix CI * Test CI update * Update CI * Fix bad reference * Organize CI a bit * Update verify-docs-build.yml * check * check * check * check * check * check * check * fixed lint * fixed lint --------- Co-authored-by: yair <yairsimantov20@gmail.com> Co-authored-by: Yair Siman Tov <63305203+yairsimantov20@users.noreply.github.com>
- Loading branch information
3 people
authored
Aug 24, 2023
1 parent
90bb2b5
commit 00287fe
Showing
179 changed files
with
38,376 additions
and
268 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
Oops, something went wrong.