open-data-registry

环境要求

• 已安装 git
• 本地有文本编辑器，能编辑 YAML 文件
• Python 环境（用于按需读取/处理 YAML 元数据）
• 能访问 GitHub 仓库 https://github.com/awslabs/open-data-registry

安装与启动步骤

1. 1克隆仓库

   把 open-data-registry 仓库下载到本地，仓库本身只存放数据集元数据，不托管实际数据。

   git clone https://github.com/awslabs/open-data-registry.git

   复制

2. 2进入数据集目录

   所有数据集条目都以 YAML 文件形式存放在 datasets 目录下，先查看已有条目作为参考。

   cd open-data-registry
   ls datasets

   复制

3. 3编写 YAML 元数据

   按 README 给出的字段结构新建一个 YAML 文件，填写名称、描述、维护方、许可、资源 ARN 等。

   vi datasets/my-dataset.yaml

   复制

4. 4提交并推送

   把新增的 YAML 文件提交到自己的分支并推送到 GitHub，随后向主仓库发起 Pull Request。

   git checkout -b add-my-dataset
   git add datasets/my-dataset.yaml
   git commit -m "Add my dataset"
   git push origin add-my-dataset

   复制

5. 5在官网核对

   PR 合并后，条目会出现在 Registry of Open Data on AWS 浏览器和托管的 YAML 列表中，可自行检索确认。

关键配置

如何确认成功

本地 datasets 目录中出现新增的 YAML 文件，且 PR 合并后能在 https://registry.opendata.aws/ 检索到该数据集。

常见问题

注意事项

• README 未提供 pip 安装或 Docker 启动方式，该项目是元数据仓库而非可运行服务，不要臆造启动命令。
• YAML 字段必须与 README 给出的结构保持一致，字段缺失或拼写错误可能导致条目无法被正确生成。
• 提交前建议先阅读 datasets 目录中已有条目的写法，保持格式统一。
• 本注册表的数据集由第三方维护，使用时请自行核对许可与引用要求。