Developer guide¶

This repository contains AntFlow's Helm chart and documentation. Contributions are reviewed through GitLab merge requests.

Choose a contribution¶

• Change the Helm chart: follow the chart contribution guide for prerequisites and local checks.
• Edit documentation: follow the documentation setup and preview instructions, then use the conventions below.

For changes in this repository, check the commit-message conventions and code of conduct.

Work on application components¶

Application code lives in separate repositories. Use the setup and contribution instructions for the component you are changing:

Documentation assets¶

The previous documentation repository stored editable diagrams as PNG files with embedded draw.io data. That workflow still applies to migrated diagram assets.

• Use draw.io to edit diagram PNG files when needed.
• Keep operational documentation close to the current repository so product and deployment content stay aligned.

Documentation conventions¶

• Match the reader's technical background. The user guide assumes no knowledge of APIs, CWL, or infrastructure: explain unfamiliar terms when introducing them. Operator and developer guides can use the technical vocabulary of their roles.
• Write in American English and use sentence case for page titles and headings. Preserve official product names, standard names, and quoted publication titles.
• Use bold for UI labels and inline code for commands, paths, configuration keys, API fields, and literal values. Write menu paths as User Settings > Applications.
• Use - for unordered lists and numbered lists for sequential instructions.
• Label fenced code blocks with their language; use shell for command examples.
• Use at least three hyphens per column in Markdown table separators.
• Indent admonition content by four spaces. Put Mermaid diagrams under separate headings, not inside tabs.
• Reuse the terms in the glossary. Distinguish workflows, processes, and jobs, and launcher backends from CWL execution engines.
• Link to the owning reference or operator task for access rules and configuration contracts rather than duplicating them in each procedure.