How istio/community works
Project type and purpose
• This is an open-source community‐infrastructure repository (“Istio Community”).
• It contains governance documentation, contribution guidelines, organizational YAMLs, shared scripts/config, and CI/CD definitions.
• It supports contributor onboarding, policy enforcement (linting/tests), and community operations (elections, working groups).
Main components
a. Developer Environment
• Local workstation or IDE, optionally using .devcontainer for VS Code.
• common/scripts invoked locally for linting, formatting, unit tests.
b. Git Repository (GitHub)
• Code and docs in top-level directories: steering/, org/, common/, prow/, plus markdown docs.
• Configuration files: CODEOWNERS, .github (SECURITY.md, pull request template), .gitignore.
c. CI/CD Pipeline
• Kubernetes-based Prow jobs (prow/ directory and prow/community-lint.sh).
• Makefile targets (Makefile, Makefile.core.mk, Makefile.overrides.mk) orchestrating build/test.
• common/config/*.yml and .scripts for lint rules (.golangci.yml, hadolint, yamllint, sass-lint, tslint).
d. External Services & Integrations
• GitHub (issues, PRs, discussions, CODEOWNERS approvals)
• Google Groups / Calendar (community meetings)
• Slack (#contributors)
• istio.io website (documentation site)
Relationships & Data Flows
• Developer triggers scripts/Makefile locally → code and docs are validated.
• Developer pushes branches → GitHub receives PR → Prow CI triggers via prow/config → runs community-lint, tests, formatting checks.
• Prow posts status back to GitHub PR.
• Upon merge, governance docs become the source of truth for community tools (org/ YAMLs feed membership automation).
• Community meetings and content referenced in docs link out to Google Calendar/Groups.
• CODEOWNERS and LABELS drive GitHub auto-assignment and approvals.
Architectural Patterns & Design Principles
• Modular scripts under common/scripts and config under common/config for reuse across multiple Istio repos.
• GitOps style: all governance/configuration (org/members.yaml, steering charters, election YAML) is stored declaratively in Git.
• Convention-over-configuration via Makefiles and Prow configuration.
• Clear separation of concerns:
• Documentation (markdown files)
• Automation (scripts + CI config)
• Organizational data (YAML)
7. In External lane, show integrations: GitHub metadata → Slack, Google Groups, Calendar, istio.io.
8. Labels for file locations (e.g., common/config, prow/, steering/).