一致的文件命名以优化搜索¶
问题描述¶
现在 RST 迁移已经稳定下来，我们可以看到，使用以前的 xml:id 作为文件名意味着一些 RST 文件名使用下划线 (_) 作为空格指示符，而另一些 RST 文件名使用连字符 (-) 作为空格指示符。
我们的约定是为所有 RST 文件使用连字符，以便生成的 HTML 文件既易于人类阅读，也易于搜索引擎阅读。
提议的变更¶
更新 openstack-manuals 仓库中的所有文件，一次更新一个指南，以符合我们使用连字符作为 RST 文件名的约定。
将任何使用下划线的 RST 文件名更改为使用连字符代替。如果文件名已经使用连字符分隔，则不要更改文件名。
仅当文件夹在 URL 中包含下划线时，才更改使用下划线的文件夹名称。
不要更改图像或图形的文件名。
更改引用使用下划线命名的文件的任何超链接。
在 www/static/.htaccess 文件中，在 Web 服务器本身上将任何旧文件名重定向到新文件名。
备选方案¶
保持文件名不变，并更改我们的约定以使用连字符或下划线。这将导致网站上文件的可查找性降低。
实现¶
负责人¶
- admin-guide：Anne Gentle
- cli-reference：Kato Tomoyuki
- config-reference：Kato Tomoyuki
- common：Akihiro Motoki
- user-guide：Mariia Zlatkova
- ops-guide：Olena Logvinova
- backporting link fixes：Akihiro Motoki
工作项¶
更改文件和链接在
- admin-guide
- cli-reference（glance_property_keys.rst 是唯一的文件）
- common
- config-reference
- ops-guide
- user-guide
这些指南不需要更改文件名
- arch-design
- config-reference
- contributor-guide
- ha-guide
- image-guide
- install-guide
- install-guide-debconf
更改 stable/mitaka 和 stable/liberty 分支中指向因非版本化交付物更改而导致文件名更改的链接，通过移植链接更改来实现。
更新 sitemap.xml 文件，以确保所有新文件名都包含在站点地图中。
依赖项¶
协调工作并提交补丁。
参考资料¶
贡献者指南：https://docs.openstack.org/contributor-guide/docs-structure.html#file-naming-conventions
为了获取工作项列表，我运行了这种类型的搜索
ls ~/src/openstack-manuals/doc/user-guide/source/ | grep _
除非另有说明，本文档根据 知识共享署名 3.0 许可协议 授权。请参阅所有 OpenStack 法律文件。