Back to Details

user-manual-preview-publishing

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

User Manual Preview Publishing

用户手册预览发布

Read provider-contract.md. Inspect a target provider's current official documentation before creating or changing an adapter.
  1. Always produce and link a private CI artifact first.
  2. Deploy an ephemeral hosted preview only when 
    User-Manual/manual.yml
    names an approved provider.
  3. Public hosting may contain only approved End User content. Administrator and Technical editions require provider-enforced authentication.
  4. Pin third-party actions according to the project's supply-chain policy.
  5. Do not expose tokens in commands, logs, configuration, preview URLs, or documentation.
  6. Skip credentialed deployment for untrusted fork PRs and explain the private-artifact fallback.
  7. Update one marker-delimited PR comment instead of creating duplicate comments.
On a feature PR, upload all editions as a repository-reader-only artifact. If a provider is approved, deploy only the allowed edition and protect internal content with an identity policy.
阅读provider-contract.md。在创建或修改适配器之前，检查目标提供商当前的官方文档。
  1. 始终先生成并链接私有CI制品。
  2. 仅当
    User-Manual/manual.yml
    中指定了经批准的提供商时，才部署临时托管预览。
  3. 公共托管仅可包含经批准的终端用户内容。管理员版和技术版需要提供商强制的身份验证。
  4. 根据项目的供应链策略固定第三方操作。
  5. 不要在命令、日志、配置、预览URL或文档中暴露令牌。
  6. 对于不受信任的分支PR，跳过需要凭证的部署，并说明私有制品的替代方案。
  7. 更新一条标记分隔的PR评论，而非创建重复评论。
在功能PR中，将所有版本上传为仅仓库阅读器可见的制品。如果提供商已获批准，仅部署允许的版本，并通过身份策略保护内部内容。