【问题标题】:Azure DevOps Wiki: What is the value of YAML atop a page's markdown?Azure DevOps Wiki:页面降价后 YAML 的价值是什么?
【发布时间】:2021-03-25 00:39:03
【问题描述】:

在 Azure DevOps Wiki 页面的 markdown 顶部添加 YAML 有什么价值,其 markdown 语法支持:Syntax guidance for Markdown usage in Wiki, YAML tags

它似乎只提供了一种用于指定表的替代语法。也许更精细的表格,但它们只会呈现在页面顶部。我错过了什么?

【问题讨论】:

标签: yaml wiki azure-devops-wiki


【解决方案1】:

作为the document中的介绍,

在 Wiki 中包含 YAML 块的任何文件都由具有一头一行的表处理。

所以,我认为 Wiki markdown 中 YAML 标签的价值在于将抽象的 YAML 语句转换为 Wiki 页面上的可视化表格,以增加可读性和快速理解。

尤其是对于可能包含多个项目或多个子项目的复杂 YAML 块,YAML 标签应该很有帮助。

[更新]

我在 GitHub 存储库“MicrosoftDocs/azure-devops-docs”上发现另一个用户报告的问题单 (MicrosoftDocs/azure-devops-docs#9976)。 This issue报告了一个类似的问题。

而在这个issue ticket里,你也可以看到@amitkumariiit给出了解释:

Yaml tags are used for general search engine optimisation. Our plan was to add the basic support for it first and then ingest this in the azure devops wiki search for optimise search. However we could not prioritise the search side of work.

如果您需要更详细的解释,您可以关注此问题票并将您的 cmets 添加到其中。

【讨论】:

  • 感谢@Bright Ran-MSFT。然而,引用的“价值”似乎是对其作用的重述。我明白它的作用。我不明白这如何增加价值?如果我希望 YAML 显示为表格,为什么我只希望它出现在页面顶部?现实世界的用例是什么?我真的看不出这是如何产生任何积极影响的。
  • 我接受您的 [UPDATE] 作为答案。谢谢。
  • @Bright-Ran-MSFT 我尝试插入我的 YAML 文件内容(Kubernetes 清单或 Spring 配置)并且渲染并没有使其更具可读性。当前实现不支持深层嵌套元素。任何比 3 层更深的东西都被包装到表格单元格中。自己试试吧。
【解决方案2】:

我将提出我自己的答案。我突然想到,这可能是为了替换 markdown,而不是与 markdown 一起使用。也就是说,支持纯粹用 YAML 编写的文档。这可能是有道理的,增加了一些价值,并解释了为什么它只在页面顶部受支持。您使用它而不是降价,而不是降价。

文档并没有明确说明您可能想要使用此功能的原因/方式。

【讨论】:

  • 这让我困惑了很长时间。我的回答很有意义——对我来说。我们将看看是否还有其他 cmets。我可能会接受我的回答。
  • 嗨@ScottWelker,请继续。
  • 嗨@ScottWelker,我已经用更多信息更新了我的答案。它可能对您有帮助。请检查一下。
  • @Bright Ran-MSFT:感谢您的“侦查”。我接受了你的回答,因为这表明我的推测是不正确的。 YAML 支持显然只是另一个功能(搜索)的不完整部分。
猜你喜欢
  • 2022-12-03
  • 2014-08-16
  • 1970-01-01
  • 1970-01-01
  • 2019-07-17
  • 1970-01-01
  • 1970-01-01
  • 2019-12-26
  • 1970-01-01
相关资源
最近更新 更多