Elastic EUI 项目缺失的 Utilities 文档内容梳理

在 Elastic EUI 项目文档迁移过程中，开发团队发现 Utilities 工具类部分存在大量内容缺失。本文将详细介绍这些缺失内容的处理过程和技术考量。

文档迁移背景

Elastic EUI 团队正在进行文档系统的全面升级，将原有文档迁移至新的文档架构。在迁移过程中，Utilities 工具类部分有多个页面未能通过自动脚本完成迁移，需要手动处理。

缺失内容清单

开发团队共识别出 22 个需要手动迁移的 Utilities 页面，包括但不限于：

• 辅助功能相关：Accessibility、Focus trap、Outside click detector
• 布局工具：Auto sizer、Resize observer、Portal
• 文本处理：Highlight and mark、Text diff、Text truncation
• 交互工具：Copy、Delay、Mutation observer
• 国际化支持：I18n
• 样式工具：Color palettes、CSS utility classes

技术处理方案

对于大部分页面，团队开发了专门的迁移脚本来自动处理内容转换。该脚本能够处理文档的基本结构和API说明部分，但示例代码部分仍需人工介入。

迁移脚本主要功能包括：

• 解析原有文档结构
• 转换格式至新文档系统要求
• 保留关键API说明
• 标记需要人工处理的示例部分

特殊案例处理

在迁移过程中，团队遇到了几个需要特别处理的案例：

1. Color palettes 页面

   • 考虑将其移至Theming主题部分更合适
   • 需要评估Sass变量部分的处理方式

2. CSS utility classes 页面

   • 同样考虑移至Theming部分
   • 长期来看可能需要弃用这些工具类

3. Provider 组件文档

   • 更适合放在Theming主题部分
   • 当前保持原样迁移，后续再调整

4. Scroll 工具文档

   • 原有文档包含CSS-in-JS/SCSS切换功能
   • 决定在新文档中仅保留Emotion方案
   • 旧版文档仍保留SCSS参考

文档链接更新

除了内容迁移外，团队还更新了多个组件文档中对Utilities部分的引用链接，确保新文档系统的内部链接一致性。这些更新涉及表单组件、骨架屏、入门指南等多个部分。

后续优化计划

团队已经创建了多个后续优化任务，包括：

• 视觉调色板文档的更新
• 工具类文档的结构优化
• 提供者组件的重新归类

这些优化将在文档系统稳定后逐步实施。

通过这次全面的文档迁移和整理，Elastic EUI 的工具类文档将更加完整和系统化，为开发者提供更好的参考体验。