yamlwikiazure-devops-wiki

Azure DevOps Wiki: What is the value of YAML atop a page's markdown?


What is the value in adding YAML atop an Azure DevOps Wiki page's markdown, as supported by its markdown syntax: Syntax guidance for Markdown usage in Wiki, YAML tags?

It seems to offer nothing more than an alternative syntax with which to specify tables. Perhaps more elaborate tables but they'll only render atop the page. What am I missing?


Solution

  • As the introduction in the document,

    Any file that contains a YAML block in a Wiki is processed by a table with one head and one row.

    So, I think the value of YAML tags in the Wiki markdown is to convert the abstract YAML statements into a visual table on the Wiki page to increase readability and quick understanding.

    Especially for a complex YAML block that may contain multiple items or multiple sub-items, the YAML tags should be very helpful.

    [UPDATE]

    I find an issue ticket (MicrosoftDocs/azure-devops-docs#9976) reported by another user on the GitHub repository "MicrosoftDocs/azure-devops-docs". This issue has reported a similar question.

    And in this issue ticket, you also can see @amitkumariiit has given an explanation:

    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.

    If you need more detailed explanation, you can follow this issue ticket and add your comments to it.