saleor-configurator

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Saleor Configurator

Saleor Configurator

Guide for using Saleor Configurator — a "commerce as code" CLI that lets you define your entire Saleor store configuration in YAML and deploy it declaratively.
使用Saleor Configurator的指南——这是一款“电商即代码”CLI工具,可让您在YAML中定义整个Saleor商店配置并以声明式方式部署。

When to Apply

适用场景

  • Writing or editing
    config.yml
    for a Saleor store
  • Running
    deploy
    ,
    introspect
    , or
    diff
    commands
  • Understanding which identifier to use (
    slug
    vs
    name
    ) for each entity
  • Debugging mismatches between local config and remote state
  • Setting up CI/CD pipelines for automated deployments
  • Migrating store configuration between environments
  • 为Saleor商店编写或编辑
    config.yml
  • 运行
    deploy
    introspect
    diff
    命令
  • 了解每个实体应使用哪种标识符(
    slug
    vs
    name
  • 调试本地配置与远程状态之间的不匹配问题
  • 设置用于自动化部署的CI/CD流水线
  • 在不同环境之间迁移商店配置

Rule Categories by Priority

按优先级划分的规则类别

PriorityCategoryImpactPrefix
1Config SchemaCRITICAL
config-
2Entity IdentityCRITICAL
identity-
3CLI WorkflowHIGH
cli-
4DeploymentHIGH
deploy-
5Diff & SyncMEDIUM
diff-
优先级类别影响程度前缀
1配置架构关键
config-
2实体标识关键
identity-
3CLI工作流
cli-
4部署
deploy-
5差异与同步
diff-

Quick Reference

快速参考

1. Config Schema (CRITICAL)

1. 配置架构(关键)

  • config-schema
    — YAML structure, all top-level keys, entity examples
  • config-schema
    — YAML结构、所有顶级键、实体示例

2. Entity Identity (CRITICAL)

2. 实体标识(关键)

  • identity-strategies
    — Slug-based vs name-based vs singleton; which entity uses which
  • identity-strategies
    — 基于slug、基于名称与单例模式;各实体对应哪种方式

3. CLI Workflow (HIGH)

3. CLI工作流(高)

  • cli-commands
    — All commands, flags, env vars, credential setup, non-interactive mode
  • cli-commands
    — 所有命令、标志、环境变量、凭证设置、非交互模式

4. Deployment (HIGH)

4. 部署(高)

  • deploy-pipeline
    — Stage order, dependency graph, selective deployment, failure handling
  • deploy-pipeline
    — 阶段顺序、依赖关系图、选择性部署、故障处理

5. Diff & Sync (MEDIUM)

5. 差异与同步(中)

  • diff-behavior
    — How diff detects changes, what triggers create/update/delete
  • diff-behavior
    — 差异检测如何识别变更,哪些操作会触发创建/更新/删除

How to Use

使用方法

Read individual rule files for detailed explanations and examples:
rules/config-schema.md
rules/identity-strategies.md
rules/cli-commands.md
rules/deploy-pipeline.md
rules/diff-behavior.md
阅读单个规则文件获取详细说明和示例:
rules/config-schema.md
rules/identity-strategies.md
rules/cli-commands.md
rules/deploy-pipeline.md
rules/diff-behavior.md

Full Compiled Document

完整编译文档

For the complete guide with all rules expanded:
AGENTS.md
如需包含所有扩展规则的完整指南,请查看:
AGENTS.md