Shared content architecture and workflow diagrams

contribution-and-deploy-flow.svg

contribution-and-deploy-flow.yaml

title: Content Contribution And Deploy Flow
direction: LR
clusters:
  - id: authoring
    label: Authoring
  - id: validation
    label: Validation And Triggering
  - id: build
    label: Site Build
  - id: publish
    label: Publish Outputs
nodes:
  - id: contributor
    label: Contributor
    cluster: authoring
  - id: content_repo
    label: content repo markdown
    cluster: authoring
  - id: validator
    label: validate_content.py
    cluster: validation
  - id: trigger_sites
    label: trigger-sites.yml
    cluster: validation
  - id: dispatch_payload
    label: repository_dispatch payload
    cluster: validation
  - id: site_workflow
    label: wikip.co generator.yml
    cluster: build
  - id: reusable_workflow
    label: hexo-deploy.yml
    cluster: build
  - id: resolve_sha
    label: resolve exact content SHA
    cluster: build
  - id: restore_mtimes
    label: restore mtimes from git history
    cluster: build
  - id: hexo_build
    label: npm clean + build
    cluster: build
  - id: public_repo
    label: public repo
    cluster: publish
  - id: dockerhub
    label: Docker Hub
    cluster: publish
  - id: email
    label: email notification
    cluster: publish
edges:
  - from: contributor
    to: content_repo
    label: edit / commit / push
  - from: content_repo
    to: validator
    label: local or CI validation
  - from: content_repo
    to: trigger_sites
    label: push to main
  - from: trigger_sites
    to: dispatch_payload
    label: include ref + sha
  - from: dispatch_payload
    to: site_workflow
    label: content-updated event
  - from: site_workflow
    to: reusable_workflow
    label: workflow_call
  - from: reusable_workflow
    to: resolve_sha
    label: detach content submodule
  - from: resolve_sha
    to: restore_mtimes
    label: content tree ready
  - from: restore_mtimes
    to: hexo_build
    label: correct updated timestamps
  - from: hexo_build
    to: public_repo
    label: commit generated static files
  - from: hexo_build
    to: dockerhub
    label: optional container image
  - from: reusable_workflow
    to: email
    label: run status

manual-agent-flow.svg

manual-agent-flow.yaml

title: Manual Agent Tooling Flow
direction: LR
clusters:
  - id: operator
    label: Operator Commands
  - id: tools
    label: Agent Tools
  - id: services
    label: External Services
  - id: repo
    label: Content Repository
nodes:
  - id: operator_shell
    label: maintainer shell
    cluster: operator
  - id: agent_workflow
    label: ./agent-workflow
    cluster: operator
  - id: queue_cmd
    label: queue
    cluster: tools
  - id: match_cmd
    label: match
    cluster: tools
  - id: prepare_cmd
    label: prepare
    cluster: tools
  - id: wiki_automation
    label: wiki-automation
    cluster: tools
  - id: gmail_reader
    label: gmail-reader
    cluster: tools
  - id: web_scraper
    label: web-scraper
    cluster: tools
  - id: image_upload
    label: image-upload
    cluster: tools
  - id: gmail
    label: Gmail / Scholar alerts
    cluster: services
  - id: source_url
    label: source article URL
    cluster: services
  - id: cloudinary
    label: Cloudinary
    cluster: services
  - id: queue_packet
    label: queue packet JSON
    cluster: repo
  - id: article_stub
    label: markdown article stub
    cluster: repo
  - id: validator
    label: validate_content.py
    cluster: repo
edges:
  - from: operator_shell
    to: agent_workflow
    label: run wrapper
  - from: agent_workflow
    to: queue_cmd
    label: queue
  - from: agent_workflow
    to: match_cmd
    label: match
  - from: agent_workflow
    to: prepare_cmd
    label: prepare
  - from: queue_cmd
    to: wiki_automation
    label: delegate
  - from: match_cmd
    to: wiki_automation
    label: delegate
  - from: prepare_cmd
    to: wiki_automation
    label: delegate
  - from: wiki_automation
    to: gmail_reader
    label: queue
  - from: wiki_automation
    to: web_scraper
    label: prepare
  - from: wiki_automation
    to: image_upload
    label: optional image upload
  - from: gmail_reader
    to: gmail
    label: search inbox
  - from: gmail_reader
    to: queue_packet
    label: candidate URLs + matches
  - from: web_scraper
    to: source_url
    label: fetch and parse
  - from: web_scraper
    to: article_stub
    label: citation packet
  - from: image_upload
    to: cloudinary
    label: upload / lookup
  - from: wiki_automation
    to: article_stub
    label: optional create-new
  - from: article_stub
    to: validator
    label: validate before commit

shared-content-architecture.svg

shared-content-architecture.yaml

title: Shared Content Project Architecture
direction: LR
clusters:
  - id: repos
    label: Git Repositories
  - id: github_actions
    label: GitHub Actions
  - id: local_ops
    label: Local Operator Workflow
  - id: services
    label: External Services
nodes:
  - id: content_repo
    label: wikip-co/content
    cluster: repos
  - id: wikip_repo
    label: wikip-co/wikip.co
    cluster: repos
  - id: personal_repo
    label: anthonyrussano/anthonyrussano.com
    cluster: repos
  - id: public_repo
    label: wikip-co/public
    cluster: repos
  - id: trigger_sites
    label: trigger-sites.yml
    cluster: github_actions
  - id: wikip_generator
    label: wikip.co generator.yml
    cluster: github_actions
  - id: reusable_workflow
    label: hexo-deploy.yml
    cluster: github_actions
  - id: manual_launcher
    label: ./agent-workflow
    cluster: local_ops
  - id: wiki_automation
    label: wiki-automation
    cluster: local_ops
  - id: gmail_reader
    label: gmail-reader
    cluster: local_ops
  - id: web_scraper
    label: web-scraper
    cluster: local_ops
  - id: image_upload
    label: image-upload
    cluster: local_ops
  - id: github_dispatch
    label: GitHub repository_dispatch
    cluster: services
  - id: github_actions_service
    label: GitHub-hosted runners
    cluster: services
  - id: cloudinary
    label: Cloudinary
    cluster: services
  - id: gmail
    label: Gmail / Google Scholar
    cluster: services
  - id: dockerhub
    label: Docker Hub
    cluster: services
edges:
  - from: content_repo
    to: trigger_sites
    label: push markdown
  - from: trigger_sites
    to: github_dispatch
    label: POST content_ref + content_sha
  - from: github_dispatch
    to: wikip_generator
    label: content-updated
  - from: wikip_repo
    to: wikip_generator
    label: push site/**
  - from: wikip_generator
    to: reusable_workflow
    label: workflow_call
  - from: reusable_workflow
    to: github_actions_service
    label: build runner
  - from: reusable_workflow
    to: content_repo
    label: checkout content submodule
  - from: reusable_workflow
    to: public_repo
    label: publish generated site
  - from: reusable_workflow
    to: dockerhub
    label: optional docker push
  - from: content_repo
    to: manual_launcher
    label: local authoring
  - from: manual_launcher
    to: wiki_automation
    label: queue / match / prepare
  - from: wiki_automation
    to: gmail_reader
    label: queue
  - from: wiki_automation
    to: web_scraper
    label: prepare
  - from: wiki_automation
    to: image_upload
    label: optional image upload
  - from: gmail_reader
    to: gmail
    label: search inbox
  - from: image_upload
    to: cloudinary
    label: upload/check assets
  - from: web_scraper
    to: content_repo
    label: article packet + citations
  - from: personal_repo
    to: github_dispatch
    label: also receives dispatch