On this page
AboutThisWiki
此页面提供有关Hive wiki的信息,包括如何编辑和导出以及 Wiki 的简要历史记录。请注意,Hive website与 Hive Wiki 是分开的。有关编辑网站的信息,请参见如何编辑网站。
如何获得编辑权限
如果您还没有Confluence account,请创建一个。
通过向user-subscribe@hive.apache.org发送消息来注册用户邮件列表。
向user@hive.apache.org发送消息:
请求对 Hive Wiki 的写权限。
- 提供您的 Confluence 用户名。
如何编辑 Hive Wiki
拥有 Wiki 编辑特权并登录后,每个 Wiki 文档(“监视和共享”旁边)的右上角将显示一个“编辑”按钮 .这将带您进入“编辑”窗口,您应该在底部的字段中 Importing 有关更改性质的简短说明(“您做了什么更改?”),然后编辑文档.顶部的横条上有相当明显的 GUI 符号,右上角的“ ”按钮有帮助。
在右下角有一个 Preview 按钮 (可通过 Edit 进行切换)和一个 Save 按钮 。编辑器会自动保存并保留您的草稿,您可以在 ID 图片(右上)的下拉列表中找到该草稿。当您使用“保存”按钮 时,电子邮件将发送给所有观看该 Wiki 页面的人,除非 您未选中底部的“通知观察者” ;但是自动保存不会通知观察者.如果您保存了某些内容然后认为所有内容都不对,则可以转到页面历史记录并将其还原.页面历史记录在每个 Wiki 页面的“工具”下拉列表中( “ ...”按钮*),但不在编辑窗口中。
优良作法是在您正在记录的JIRA issue上添加 Comment,并提供指向 Wiki 页面的链接,以便观看此问题的人员可以查看您的更改,并且将来 JIRA 拖网渔船可以轻松找到该文档。有关 JIRA 的更多信息,请参见下面的如何查找文档任务。注意,Confluence 标记语法与 JIRA 相同,因为它们来自同一公司。
Version information
请在您的更改中包括 Hive 版本信息,因为 Wiki 涵盖了 Hive 的所有发行版。
您可以在文本或类似这样的版本信息框中提供版本(单击 “图标 ,从下拉列表中选择” Info“,然后 Importing” Version“或” Version information“作为标题)。要链接到 JIRA 问题,请突出显示some text或问题 ID(例如HIVE-10000),然后点击 插入链接图标 (页面右上角),使用左侧的“网络链接”选项“插入链接”窗口。
Wiki 的其他部分的链接应使用“插入链接”窗口的“高级”,“搜索”或“最近查看”选项进行,而不是使用“ Web 链接”选项,以便 Confluence 可以自动调整链接到任何已重命名的部分。
如果要重命名节并要保留到该节的外部链接,则应在更改标题之前或之后在文本段落中添加旧标题的锚点。 (不要将锚点放在标题上,因为这会影响内部链接.)锚点也可以用于链接到节中的文本或图形。要插入锚点,请使用 “”图标 并在下拉列表底部选择“其他宏”。例如,在“编辑”模式下查看this section。
Advanced links
对于 Wiki 中的“高级”链接,“链接”字段区分大小写。指向 Hive Wiki 页面的高级链接仅使用该页面顶部所示的标题,其中可以包含空格,也可以不包含空格:
Wiki 页面中的部分用“#”符号标记。子标题与主要标题的处理相同:
指向同一 Wiki 页面上某个部分的高级链接仅需要“#”和“链接”字段中的标题文本:
锚点的链接与部分相同:
如何查找文档任务
在阅读 Wiki 时,您可能会发现需要改进的地方。例如,如果您发现 Wiki 中的断开链接,请在this list中查找页面名称并修复该链接。
在 JIRA 问题中,使用附加了版本的 TODOC 标签(例如 TODOC2.0 和 TODOC1.3)来跟踪文档任务。从 0.10 到 0.14 的版本省略了前导“ 0.”,例如 TODOC12.
以下内容可以快速找到可能需要进一步说明的项目:
选择问题-使用右上角的“搜索”字段(按 Enter 键(带有或不带有搜索字符串))
选择项目–Hive
选择“更多”。将标签标记为 TODOC(区分大小写)
将过滤器另存为
另一个选项是搜索字符串“ Doc note:”,尽管这会同时选择打开和完成的任务。
完成并验证了文档后,可以从问题中删除 TODOC 标签。
注意:TODOC 标签始于 TODOC10,版本为 0.10. 即使 Hive 达到版本 10.0,TODOC10 和 TODOC10.0 标签也可以通过是否存在点号来区分。
如何导出 Hive Wiki
Hive Wiki 可以导出为 HTML,XML 或 PDF。各个页面可以导出为 PDF,EPUB或 Word。
要获得导出许可,请将请求发送到user@hive.apache.org,以请求导出访问权限并提供您的 Confluence 用户名(请参见上面的如何获得编辑权限)。
要导出整个 Hive Wiki 或选定页面,请使用 Space Tools(任何 Wiki 页面的左侧),然后选择 Content Tools(Space Tools 的顶部栏),然后选择 Export 选项卡。选择一种导出格式,然后单击“下一步”。选择完全导出或自定义导出,然后单击导出。对于自定义导出,您可以选择要导出的页面。
要导出当前 Wiki 页面,请使用“工具”下拉列表(在任何页面的右上角),然后选择“导出为 PDF”,“导出为 EPUB”或“导出为 Word”。
History
Apache Hive Wiki 最初是 Apache Hadoop MoinMoin Wiki 中的子空间(当时 Hive 仍是 Hadoop 子项目)。当 Hive 毕业成为顶级项目时,我们将其 Wiki 移到了 Confluence 顶级 Wiki。 (MoinMoin Wiki 受到垃圾邮件发送者的攻击,验证码没有帮助,而且似乎没有一种使用访问控制来保护 Hive 子空间的方法.)
就像 true 的举动一样,有时东西在运输过程中会破裂。 MoinMoin 和 Confluence 标记语言有些不同,并且我们使用的迁移工具不能完美保留所有内容。
为了防止对 MoinMoin 源进行进一步的编辑,我们已删除了那里的所有页面(将其替换为有关如何查找其新位置的说明),但是如果发现所有内容完全丢失,我们将对 MoinMoin 数据进行完整备份在移动。